This repository was archived by the owner on Sep 18, 2023. It is now read-only.
[master < E-add-neighbors] Add docs for neighbors module #998
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
vpavicic
reviewed
Aug 17, 2023
mage/query-modules/cpp/neighbors.md
Outdated
Comment on lines
44
to
46
| - `node: Node` ➡ node whose neighborhood is being analyzed | ||
| - `rel_type: List[string]` ➡ list of relationship types to travel through; if empty, it is possible to travel through all types of relationships | ||
| - `distance: int` ➡ number of hops between nodes |
Collaborator
There was a problem hiding this comment.
Suggested change
| - `node: Node` ➡ node whose neighborhood is being analyzed | |
| - `rel_type: List[string]` ➡ list of relationship types to travel through; if empty, it is possible to travel through all types of relationships | |
| - `distance: int` ➡ number of hops between nodes | |
| - `node: Node` ➡ node whose neighborhood is being analyzed. | |
| - `rel_type: List[string]` ➡ list of relationship types to travel through; if empty, it is possible to travel through all types of relationships. | |
| - `distance: int` ➡ number of hops between nodes. |
vpavicic
reviewed
Aug 17, 2023
mage/query-modules/cpp/neighbors.md
Outdated
|
|
||
| #### Output: | ||
|
|
||
| - `nodes: Node` ➡ nodes at a specific distance from a given node |
Collaborator
There was a problem hiding this comment.
Suggested change
| - `nodes: Node` ➡ nodes at a specific distance from a given node | |
| - `nodes: Node` ➡ nodes at a specific distance from a given node. |
vpavicic
reviewed
Aug 17, 2023
mage/query-modules/cpp/neighbors.md
Outdated
Comment on lines
73
to
75
| - `node: Node` ➡ node whose neighborhood is being analyzed | ||
| - `rel_type: List[string]` ➡ list of relationship types to travel through; if empty, it is possible to travel through all types of relationships | ||
| - `distance: int` ➡ maximum number of hops between nodes |
Collaborator
There was a problem hiding this comment.
Suggested change
| - `node: Node` ➡ node whose neighborhood is being analyzed | |
| - `rel_type: List[string]` ➡ list of relationship types to travel through; if empty, it is possible to travel through all types of relationships | |
| - `distance: int` ➡ maximum number of hops between nodes | |
| - `node: Node` ➡ node whose neighborhood is being analyzed. | |
| - `rel_type: List[string]` ➡ list of relationship types to travel through; if empty, it is possible to travel through all types of relationships. | |
| - `distance: int` ➡ maximum number of hops between nodes. |
vpavicic
reviewed
Aug 17, 2023
mage/query-modules/cpp/neighbors.md
Outdated
|
|
||
| #### Output: | ||
|
|
||
| - `nodes: List[Node]` ➡ list of nodes at a specific distance from a given node, starting from distance 1 up to a provided distance |
Collaborator
There was a problem hiding this comment.
Suggested change
| - `nodes: List[Node]` ➡ list of nodes at a specific distance from a given node, starting from distance 1 up to a provided distance | |
| - `nodes: List[Node]` ➡ list of nodes at a specific distance from a given node, starting from distance 1 up to a provided distance. |
vpavicic
reviewed
Aug 30, 2023
mage/query-modules/cpp/neighbors.md
Outdated
|
|
||
| #### Input: | ||
|
|
||
| - `node: Node` ➡ node whose neighborhood is being analyzed. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - `node: Node` ➡ node whose neighborhood is being analyzed. | |
| - `node: Node` ➡ node for which neighborhood is being analyzed. |
nodes are not persons
Collaborator
There was a problem hiding this comment.
can you please change that across all of your prs?
vpavicic
reviewed
Aug 30, 2023
mage/query-modules/cpp/neighbors.md
Outdated
|
|
||
| ### `by_hop(node, rel_type, distance)` | ||
|
|
||
| Returns nodes that are at every distance (up to a specified number) from a given node, considering only the relationships of a specified type. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Returns nodes that are at every distance (up to a specified number) from a given node, considering only the relationships of a specified type. | |
| Returns nodes that are at any or up to a specific distance from a given node, considering only the relationships of a specified type. |
vpavicic
suggested changes
Aug 30, 2023
Collaborator
vpavicic
left a comment
vpavicic
left a comment
There was a problem hiding this comment.
the whose and 1 sentence
vpavicic
added
status: change
ind1xa
added
status: ready
vpavicic
approved these changes
Aug 30, 2023
vpavicic
added
status: ship it
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
Add documentation for neighbors module.
Pull request type
Please delete options that are not relevant and check the ones that are.
Related PRs and issues
PR this doc page is related to: memgraph/mage#308
Closes (link to issue):
Checklist: