adding description for network_generator argument

OpenFreeEnergy · Nov 15, 2024 · 6e61290 · 6e61290
1 parent 1df4ab7
commit 6e61290
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/konnektor/network_planners/generators/_abstract_network_generator.py b/src/konnektor/network_planners/generators/_abstract_network_generator.py
@@ -24,6 +24,7 @@ def __init__(
         self,
         mappers: Union[AtomMapper, list[AtomMapper]],
         scorer,
+        ## TODO: rename this to network_algorithm?
         network_generator: _AbstractNetworkAlgorithm,
         n_processes: int = 1,
         progress: bool = False,
@@ -40,7 +41,7 @@ def __init__(
             lowest score edges
         scorer : AtomMappingScorer
             Any callable which takes a AtomMapping and returns a float
-        network_generator:
+        network_generator: the network algorithm to use
         n_processes: int, optional
             Number of processes that can be used for the network generation. (default: 1)
         progress: bool, optional