mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-24 11:44:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

bpo-42588: Update the docs for the TopologicalSorter.static_order() method (GH-26834)

Browse source
This commit is contained in:
andrei kulakov 2021-06-29 06:54:28 -04:00 • committed by GitHub
parent 6cb145d23f
commit 0d7f7975d5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/library/graphlib.rst
View file

@ -154,9 +154,10 @@
.. method:: static_order()
Returns an iterable of nodes in a topological order. Using this method
does not require to call :meth:`TopologicalSorter.prepare` or
:meth:`TopologicalSorter.done`. This method is equivalent to::
Returns an iterator object which will iterate over nodes in a topological
order. When using this method, :meth:`~TopologicalSorter.prepare` and
:meth:`~TopologicalSorter.done` should not be called. This method is
equivalent to::
def static_order(self):
self.prepare()
@ -206,4 +207,4 @@ The :mod:`graphlib` module defines the following exception classes:
The detected cycle can be accessed via the second element in the :attr:`~CycleError.args`
attribute of the exception instance and consists in a list of nodes, such that each node is,
in the graph, an immediate predecessor of the next node in the list. In the reported list,
the first and the last node will be the same, to make it clear that it is cyclic.
the first and the last node will be the same, to make it clear that it is cyclic.