[Python-checkins] [doc] Fix typo in the graphlib docs (GH-22661)
linchiwei123
webhook-mailer at python.org
Mon Oct 12 10:33:44 EDT 2020
https://github.com/python/cpython/commit/abe244c458f2b1a727af4d2a56f71813e501bcb4
commit: abe244c458f2b1a727af4d2a56f71813e501bcb4
branch: master
author: linchiwei123 <40888469+linchiwei123 at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2020-10-12T07:33:34-07:00
summary:
[doc] Fix typo in the graphlib docs (GH-22661)
Automerge-Triggered-By: @pablogsal
files:
M Lib/graphlib.py
diff --git a/Lib/graphlib.py b/Lib/graphlib.py
index 948f62f1dc303..d0e7a4814c565 100644
--- a/Lib/graphlib.py
+++ b/Lib/graphlib.py
@@ -22,7 +22,8 @@ def __init__(self, node):
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
and included in the exception. The detected cycle can be accessed via the second
@@ -129,7 +130,7 @@ def get_ready(self):
return result
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
are still nodes ready that haven't yet been returned by "get_ready" or the
@@ -149,7 +150,7 @@ def done(self, *nodes):
"""Marks a set of nodes returned by "get_ready" as processed.
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
processed by a previous call to this method, if a node was not added to the
More information about the Python-checkins
mailing list