doc: update documentation when providing an iterator over current graph to add/remove_edges_from.#6268
Merged
MridulS merged 16 commits intonetworkx:mainfrom Dec 12, 2022
Conversation
dschult
reviewed
Dec 10, 2022
Member
dschult
left a comment
There was a problem hiding this comment.
This looks nice -- and the issue has been around a long time without action... so thanks!
I have wording suggestions -- they are optional, so decide what words you think work best. The start of the notes seems awkward and in the last sentence, the word "variable" isn't quite right since the list often isn't assigned to a variable name.
For the notes sections, perhaps start with:
When adding nodes from an iterator over the graph you are changing, ...
for the last sentence, maybe replace "variable" with "object" in two places in the last sentence.
Thanks!!
Contributor
Author
|
Thank you, @dschult , I think it reads better now! I also hesitated about the |
MridulS
pushed a commit
to MridulS/networkx
that referenced
this pull request
Feb 4, 2023
…ph to add/remove_edges_from. (networkx#6268) * doc for add_edges_from * doc for digraph * doc for multigraph * multigraph.add_nodes_from returns keylist * update docs for graph - edges * doc update: graph.add_nodes_from * doc update: graph.remove_nodes_from * doc update: graph.add_edges_from * doc update: rewording for graph.add_edges_from * doc update: graph.add_weighted_edges_from rewording * doc update: digraph updated as graph * doc update: digraph minor sync * doc update: multigraph same as graph * Update graph.py * Update digraph.py * Update multigraph.py
cvanelteren
pushed a commit
to cvanelteren/networkx
that referenced
this pull request
Apr 22, 2024
…ph to add/remove_edges_from. (networkx#6268) * doc for add_edges_from * doc for digraph * doc for multigraph * multigraph.add_nodes_from returns keylist * update docs for graph - edges * doc update: graph.add_nodes_from * doc update: graph.remove_nodes_from * doc update: graph.add_edges_from * doc update: rewording for graph.add_edges_from * doc update: graph.add_weighted_edges_from rewording * doc update: digraph updated as graph * doc update: digraph minor sync * doc update: multigraph same as graph * Update graph.py * Update digraph.py * Update multigraph.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #2717