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

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

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()