docs: fix misleading example on walker traversal of FriendsWith edges #2878
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 current documentation for walker traversal shows the example:
# Now, tell the walker to go to all connected friends
visit [->:FriendsWith:->];
However, this is misleading. The walker does *not* visit "all connected friends" if
the graph contains edges pointing into the current node. For example, starting
the walker from Bob or Charlie in a simple FriendsWith network will skip some
connections, because [->:FriendsWith:->] only follows *outgoing* edges.
To correctly traverse all connected friends regardless of edge direction, the
example should use:
visit [<-:FriendsWith:->];
This tells the walker to follow both incoming (<-) and outgoing (->)
FriendsWith edges, which matches the intended "all connected friends" behavior.
This commit updates the comment and example code in the docs to prevent
confusion for new Jac learners. It also aligns the explanation with the actual
runtime behavior.
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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 current documentation for walker traversal shows the example:
However, this is misleading. The walker does not visit "all connected friends" if the graph contains edges pointing into the current node. For example, starting the walker from Bob or Charlie in a simple FriendsWith network will skip some connections, because [->:FriendsWith:->] only follows outgoing edges.
To correctly traverse all connected friends regardless of edge direction, the example should use:
This tells the walker to follow both incoming (<-) and outgoing (->) FriendsWith edges, which matches the intended "all connected friends" behavior.
This commit updates the example code in the docs to prevent confusion for new Jac learners. It also aligns the explanation with the actual runtime behavior.
Description