From b617471677c914d94fb1777da281f5e9224a4ada Mon Sep 17 00:00:00 2001 From: Jordan Rozum Date: Fri, 1 Mar 2024 13:11:11 -0500 Subject: [PATCH] fix last errors for autodoc --- balm/motif_avoidant.py | 19 +++++++++++-------- balm/succession_diagram.py | 15 ++++++++------- 2 files changed, 19 insertions(+), 15 deletions(-) diff --git a/balm/motif_avoidant.py b/balm/motif_avoidant.py index 13e2c69..4def880 100644 --- a/balm/motif_avoidant.py +++ b/balm/motif_avoidant.py @@ -1,5 +1,5 @@ """ - A module responsible for detecting motif-avoidant attractors within terminal restriction space. +A module responsible for detecting motif-avoidant attractors within terminal restriction space. """ from __future__ import annotations @@ -103,13 +103,16 @@ def detect_motif_avoidant_attractors( """ Compute a sub-list of `candidates` which correspond to motif-avoidant attractors. Other method inputs: - - `graph` and `petri_net` represent the model in which the property - should be checked. - - `terminal_restriction_space` is a symbolic set of states which contains - all motif avoidant attractors (i.e. if a candidate state can leave this - set, the candidate cannot be an attractor). - - `max_iterations` specifies how much time should be spent on the "simpler" - preprocessing before applying a more complete method. + + `graph` and `petri_net` represent the model in which the property + should be checked. + + `terminal_restriction_space` is a symbolic set of states which contains + all motif avoidant attractors (i.e. if a candidate state can leave this + set, the candidate cannot be an attractor). + + `max_iterations` specifies how much time should be spent on the "simpler" + preprocessing before applying a more complete method. """ if ensure_subspace is None: ensure_subspace = {} diff --git a/balm/succession_diagram.py b/balm/succession_diagram.py index c2fa3fb..e06fb76 100644 --- a/balm/succession_diagram.py +++ b/balm/succession_diagram.py @@ -677,13 +677,14 @@ def expand_bfs( ) -> bool: """ Explore the succession diagram in a BFS manner. - - If `node_id` is given, initiate BFS from this node. Otherwise use - root. - - If `bfs_level_limit` is given, this is the last "level" (distance - from the initial node) - of nodes that should be expanded (any subsequent child nodes are - left unexplored). - If `size_limit` is given, the procedure stops - once `SuccessionDiagram` exceeds the given size. + + If `node_id` is given, initiate BFS from this node. Otherwise use root. + If `bfs_level_limit` is given, this is the last "level" (distance from + the initial node) of nodes that should be expanded (any subsequent child + nodes are left unexplored). + + If `size_limit` is given, the procedure stops once `SuccessionDiagram` + exceeds the given size. With default settings, the method will explore the whole succession diagram without any restrictions.