Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Fix typo in the graphlib docs #22661

Merged
merged 4 commits into from
Oct 12, 2020
Merged

[doc] Fix typo in the graphlib docs #22661

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a1fbcbb
[doc] Fix typo in the graphlib docs
linchiwei123 Oct 12, 2020
3cc3ab9
More specific, like in the documentation
linchiwei123 Oct 12, 2020
d710cb1
Update Lib/graphlib.py
pablogsal Oct 12, 2020
c25eee5
Update Lib/graphlib.py
pablogsal Oct 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions Lib/graphlib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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"
pablogsal marked this conversation as resolved.
Show resolved Hide resolved

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
Expand Down