DOC: Link methods in functions to base Graph methods/properties #7125
Conversation
This file contains 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
rossbar
approved these changes
Nov 20, 2023
networkx/classes/function.py
Outdated
| """Returns an iterator over the graph nodes.""" | ||
| """Returns a NodeView over the graph nodes. | ||
|
|
||
| This function wraps the :func:`networkx.Graph.nodes` property. |
There was a problem hiding this comment.
Perhaps we want to use the ~ to suppress the full object; I'm thinking that might help with ambiguity about the graph type (which the function preserves). Another option might be :func:`G.nodes <networkx.Graph.nodes>` to illustrate that it's the property of the instance G. YMMV though - there's no clear winner and I think it's fine as is!
There was a problem hiding this comment.
Yeah I think that makes sense, it may not be the "right" doc in the case of Multi/DiGraph but it should do the job.
cvanelteren
pushed a commit
to cvanelteren/networkx
that referenced
this pull request
Apr 22, 2024
…orkx#7125) * DOC: Link methods in functions to base Graph methods/properties * make it pretty
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This links the functions.py docstrings to the base Graph class, should resolve #7124