summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-06-29 11:14:52 (GMT)
committerGitHub <noreply@github.com>2021-06-29 11:14:52 (GMT)
commitd9fc4c3deb617beb1d0bbfdb4efc905a4192ff0a (patch)
treeb192802e3c486567c7b8bb5cbbea37ee4782e0a5
parenta6acd1ab08cf684d63beb290e246699dce54b539 (diff)
downloadcpython-d9fc4c3deb617beb1d0bbfdb4efc905a4192ff0a.zip
cpython-d9fc4c3deb617beb1d0bbfdb4efc905a4192ff0a.tar.gz
cpython-d9fc4c3deb617beb1d0bbfdb4efc905a4192ff0a.tar.bz2
bpo-42588: Update the docs for the TopologicalSorter.static_order() method (GH-26834)
(cherry picked from commit 0d7f7975d55eff7e3dfcebd14e765fc6cd7d3e40) Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
-rw-r--r--Doc/library/graphlib.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/library/graphlib.rst b/Doc/library/graphlib.rst
index 0faca21..2bc80da 100644
--- a/Doc/library/graphlib.rst
+++ b/Doc/library/graphlib.rst
@@ -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. \ No newline at end of file
+ the first and the last node will be the same, to make it clear that it is cyclic.