Update graph.rst - teachers to lectures #371
Open
Conversation
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
The graph linking should be teachers to lectures
instead teachers to teachers
teach = school.create_edge_definition(
edge_collection='teach',
from_vertex_collections=['teachers'],
to_vertex_collections=['lectures']
)
apetenchea
reviewed
May 16, 2025
There was a problem hiding this comment.
This is somewhat debatable, see the whole example:
# Create an edge definition named "teach". This creates any missing
# collections and returns an API wrapper for "teach" edge collection.
if not school.has_edge_definition('teach'):
teach = school.create_edge_definition(
edge_collection='teach',
from_vertex_collections=['teachers'],
to_vertex_collections=['teachers']
)
# List edge definitions.
school.edge_definitions()
# Replace the edge definition.
school.replace_edge_definition(
edge_collection='teach',
from_vertex_collections=['teachers'],
to_vertex_collections=['lectures']
)The edge definition is replaced with the correct one later on. I am not sure if this was intended to illustrate a replacement use-case, or if was a mistake.
I suggest making it obvious this time by also editing the replace_edge_definition call too with something like:
# Replace the edge definition.
school.replace_edge_definition(
edge_collection='teach',
from_vertex_collections=['teachers'],
to_vertex_collections=['new_lectures']
)This way we've got teachers->lectures which gets replaced by teachers->new_lectures. I feel like it illustrates the point even better.
What do you think?
Open
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.
The graph linking should be teachers to lectures
instead teachers to teachers
teach = school.create_edge_definition(
edge_collection='teach',
from_vertex_collections=['teachers'],
to_vertex_collections=['lectures']
)