DOC: minor doc_string changes to check write access (#70)

* make small change to test permissions

* Update test_get_chunks.py

* updated docstring

---------

Co-authored-by: Aditi Juneja <[email protected]>
Co-authored-by: Schefflera-Arboricola <[email protected]>

Author: dschult

_nx_parallel/update_get_info.py

@@ -13,7 +13,9 @@
 
 
 def get_funcs_info():
-    """Return a dictionary with information about all the functions."""
+    """Return a dictionary with function names as keys and function's details as values.
+    The function's details include the URL to the function in the source code, the parallel
+    computation description, and the additional parameters description."""
     funcs = {}
 
     nx_parallel_dir = os.path.join(os.getcwd(), "nx_parallel")

nx_parallel/tests/test_get_chunks.py

@@ -10,7 +10,12 @@
 
 
 def get_all_functions(package_name="nx_parallel"):
-    """Returns a dictionary where the keys are the function names in a given Python package, and the values are dictionaries containing the function's keyword arguments and positional arguments."""
+    """Returns a dict keyed by function names to its arguments.
+
+    This function constructs a dictionary keyed by the function
+    names in the package `package_name` to dictionaries containing
+    the function's keyword arguments and positional arguments.
+    """
     package = importlib.import_module(package_name)
     functions = {}
 
@@ -23,7 +28,7 @@ def get_all_functions(package_name="nx_parallel"):
 
 
 def get_functions_with_get_chunks():
-    """Returns a list of functions with the `get_chunks` kwarg."""
+    """Returns a list of function names with the `get_chunks` kwarg."""
     all_funcs = get_all_functions()
     get_chunks_funcs = []
     for func in all_funcs: