From 6e612907553509c04e369ca92a01da8135ea4f4c Mon Sep 17 00:00:00 2001
From: Alyssa Travitz <atravitz@umich.edu>
Date: Fri, 15 Nov 2024 08:06:17 -0800
Subject: [PATCH] adding description for network_generator argument

---
 .../network_planners/generators/_abstract_network_generator.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/konnektor/network_planners/generators/_abstract_network_generator.py b/src/konnektor/network_planners/generators/_abstract_network_generator.py
index 382ee81..ef7f8d0 100644
--- 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