styling

_nx_parallel/__init__.py

@@ -51,7 +51,7 @@ def get_info():
             },
             "approximate_all_pairs_node_connectivity": {
                 "url": "https://github.com/networkx/nx-parallel/blob/main/nx_parallel/algorithms/approximation/connectivity.py#L12",
-                "additional_docs": "blah The parallel implementation first divides the a list of all permutation (in case of directed graphs) and combinations (in case of undirected graphs) of `nbunch` into chunks and then creates a generator to lazily compute the local node connectivities for each chunk, and then employs joblib's `Parallel` function to execute these computations in parallel across all available CPU cores. At the end, the results are aggregated into a single dictionary and returned.",
+                "additional_docs": "blah blah The parallel implementation first divides the a list of all permutation (in case of directed graphs) and combinations (in case of undirected graphs) of `nbunch` into chunks and then creates a generator to lazily compute the local node connectivities for each chunk, and then employs joblib's `Parallel` function to execute these computations in parallel across all available CPU cores. At the end, the results are aggregated into a single dictionary and returned.",
                 "additional_parameters": {
                     'get_chunks : str, function (default = "chunks")': "A function that takes in `list(iter_func(nbunch, 2))` as input and returns an iterable `pairs_chunks`, here `iter_func` is `permutations` in case of directed graphs and `combinations` in case of undirected graphs. The default is to create chunks by slicing the list into `n` chunks, where `n` is the number of CPU cores, such that size of each chunk is atmost 10, and at least 1."
                 },

_nx_parallel/update_get_info.py

@@ -93,6 +93,7 @@ def extract_from_docs(docstring):
                 par_params[j[0]] = " ".join(
                     [line.strip() for line in j[1:-1] if line.strip()]
                 )
+                par_docs = par_docs.replace("\n", " ")
     except IndexError:
         par_params = None
     except Exception as e:

nx_parallel/algorithms/approximation/connectivity.py

@@ -12,7 +12,7 @@
 def approximate_all_pairs_node_connectivity(
     G, nbunch=None, cutoff=None, get_chunks="chunks"
 ):
-    """blah The parallel implementation first divides the a list of all permutation (in case
+    """blah blah The parallel implementation first divides the a list of all permutation (in case
     of directed graphs) and combinations (in case of undirected graphs) of `nbunch`
     into chunks and then creates a generator to lazily compute the local node
     connectivities for each chunk, and then employs joblib's `Parallel` function to