barak/cayley
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

fix gremlin documentation for In and Both

Browse source 
this was likely a copy/paste from Out.
feel free to change the wording to fit your style.
This commit is contained in:
Jay Graves 2014-06-29 10:14:05 -05:00
parent 075ea36f1b
commit 91e18f2978
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/GremlinAPI.md
View file

@ -108,16 +108,16 @@ g.V("D").Out(g.V("status"), "pred")
Arguments: Arguments:
* `predicatePath` (Optional): One of: * `predicatePath` (Optional): One of:
* null or undefined: All predicates pointing out from this node * null or undefined: All predicates pointing into this node
* a string: The predicate name to follow out from this node * a string: The predicate name to follow into this node
* a list of strings: The predicates to follow out from this node * a list of strings: The predicates to follow into this node
* a query path object: The target of which is a set of predicates to follow. * a query path object: The target of which is a set of predicates to follow.
* `tags` (Optional): One of: * `tags` (Optional): One of:
* null or undefined: No tags * null or undefined: No tags
* a string: A single tag to add the predicate used to the output set. * a string: A single tag to add the predicate used to the output set.
* a list of strings: Multiple tags to use as keys to save the predicate used to the output set. * a list of strings: Multiple tags to use as keys to save the predicate used to the output set.
Same as In, but in the other direction. Starting with the nodes in `path` on the object, follow the triples with predicates defined by `predicatePath` to their subjects. Same as Out, but in the other direction. Starting with the nodes in `path` on the object, follow the triples with predicates defined by `predicatePath` to their subjects.
Example: Example:
```javascript ```javascript
@ -134,9 +134,9 @@ g.V("E").Out("follows").In("follows")
Arguments: Arguments:
* `predicatePath` (Optional): One of: * `predicatePath` (Optional): One of:
* null or undefined: All predicates pointing out from this node * null or undefined: All predicates pointing both into and out from this node
* a string: The predicate name to follow out from this node * a string: The predicate name to follow both into and out from this node
* a list of strings: The predicates to follow out from this node * a list of strings: The predicates to follow both into and out from this node
* a query path object: The target of which is a set of predicates to follow. * a query path object: The target of which is a set of predicates to follow.
* `tags` (Optional): One of: * `tags` (Optional): One of:
* null or undefined: No tags * null or undefined: No tags