Skip to content

Commit

Permalink
docs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
RiesBen committed May 12, 2024
1 parent b5625d9 commit 66f4a3a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/api/konnektor.planners.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ konnektor.network\_planners.generators
:undoc-members:
:show-inheritance:

.. automodule:: konnektor.network_planners.generators.star_network_network_generator
.. automodule:: konnektor.network_planners.generators.star_network_generator
:members:
:undoc-members:
:show-inheritance:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ def __init__(self, mapper: AtomMapper, scorer,
cycle_sizes: Union[int, List[int]] = 3,
n_processes: int = 1,
_initial_edge_lister: NetworkGenerator = None):
"""
the cyclic ligand planner tries to build up a network in which each
"""the cyclic ligand planner tries to build up a network in which each
node is contained in n cycles of a given size or size range.
In order to do so, and to be time efficient, the class uses greedy
algorithms to solve the problem.
Expand All @@ -44,10 +43,9 @@ def __init__(self, mapper: AtomMapper, scorer,
(default: 1)
_initial_edge_lister: LigandNetworkPlanner, optional
this LigandNetworkPlanner is used to give the initial set of edges.
For standard usage, the Maximal NetworPlanner is used.
For standard usage, the Maximal NetworPlanner is used.
However in large scale approaches, it might be interesting to use
the heuristicMaximalNetworkPlanner. (default: MaximalNetworkPlanner)
"""

network_generator = nx_CNG(
Expand Down

0 comments on commit 66f4a3a

Please sign in to comment.