[doc] Fix typo in the graphlib docs (GH-22661)
Automerge-Triggered-By: @pablogsal
This commit is contained in:
parent
8adf8d1ec4
commit
abe244c458
|
@ -22,7 +22,8 @@ class _NodeInfo:
|
||||||
|
|
||||||
|
|
||||||
class CycleError(ValueError):
|
class CycleError(ValueError):
|
||||||
"""Subclass of ValueError raised by TopologicalSorterif cycles exist in the graph
|
"""Subclass of ValueError raised by TopologicalSorter.prepare if cycles
|
||||||
|
exist in the working graph.
|
||||||
|
|
||||||
If multiple cycles exist, only one undefined choice among them will be reported
|
If multiple cycles exist, only one undefined choice among them will be reported
|
||||||
and included in the exception. The detected cycle can be accessed via the second
|
and included in the exception. The detected cycle can be accessed via the second
|
||||||
|
@ -129,7 +130,7 @@ class TopologicalSorter:
|
||||||
return result
|
return result
|
||||||
|
|
||||||
def is_active(self):
|
def is_active(self):
|
||||||
"""Return True if more progress can be made and ``False`` otherwise.
|
"""Return ``True`` if more progress can be made and ``False`` otherwise.
|
||||||
|
|
||||||
Progress can be made if cycles do not block the resolution and either there
|
Progress can be made if cycles do not block the resolution and either there
|
||||||
are still nodes ready that haven't yet been returned by "get_ready" or the
|
are still nodes ready that haven't yet been returned by "get_ready" or the
|
||||||
|
@ -149,7 +150,7 @@ class TopologicalSorter:
|
||||||
"""Marks a set of nodes returned by "get_ready" as processed.
|
"""Marks a set of nodes returned by "get_ready" as processed.
|
||||||
|
|
||||||
This method unblocks any successor of each node in *nodes* for being returned
|
This method unblocks any successor of each node in *nodes* for being returned
|
||||||
in the future by a a call to "get_ready"
|
in the future by a call to "get_ready".
|
||||||
|
|
||||||
Raises :exec:`ValueError` if any node in *nodes* has already been marked as
|
Raises :exec:`ValueError` if any node in *nodes* has already been marked as
|
||||||
processed by a previous call to this method, if a node was not added to the
|
processed by a previous call to this method, if a node was not added to the
|
||||||
|
|
Loading…
Reference in New Issue