]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-42588: Update the docs for the TopologicalSorter.static_order() method (GH-26834)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 29 Jun 2021 11:14:52 +0000 (04:14 -0700)
committerGitHub <noreply@github.com>
Tue, 29 Jun 2021 11:14:52 +0000 (04:14 -0700)
(cherry picked from commit 0d7f7975d55eff7e3dfcebd14e765fc6cd7d3e40)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
Doc/library/graphlib.rst

index 0faca2186b268cc5ac66e144952574b5f6ef01ee..2bc80da4ead2a252e573f202485adde3fc576343 100644 (file)
 
    .. 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.