Change occurrences of V with N in the documentation.#357
Closed
glandium wants to merge 1 commit intopetgraph:masterfrom
Closed
Change occurrences of V with N in the documentation.#357glandium wants to merge 1 commit intopetgraph:masterfrom
V with N in the documentation.#357glandium wants to merge 1 commit intopetgraph:masterfrom
Conversation
The petgraph structs are generic over `N` (node) rather than `V`, so the use of `V` (which stands for vertices, but that's rarelt spelled out) in the documentation is confusing. Also change occurrences of vertex/vertices with node/nodes in rustdoc comments, for more consistency. Fixes: petgraph#356
mifrandir
suggested changes
Jul 12, 2020
Contributor
mifrandir
left a comment
mifrandir
left a comment
There was a problem hiding this comment.
I think V as the set of nodes/vertices is a very widely used convention and it would be weird to change it to N because a) N has not been used before in this library (as far as I can tell) and b) people probably associate N with a number rather than a set.
If we want to keep using "nodes" instead of "vertices", I'd argue that all the explicit occurrences should be replaced accordingly but the symbol for the set of nodes should remain V anyways.
Collaborator
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.
The petgraph structs are generic over
N(node) rather thanV, so theuse of
V(which stands for vertices, but that's rarelt spelled out) inthe documentation is confusing.
Also change occurrences of vertex/vertices with node/nodes in rustdoc
comments, for more consistency.
Fixes: #356