Suhas Udeda created TINKERPOP-1840:
--------------------------------------
Summary: Explanation about certain functions like emit()
Key: TINKERPOP-1840
URL: https://issues.apache.org/jira/browse/TINKERPOP-1840
Project: TinkerPop
Issue Type: Improvement
Components: documentation
Affects Versions: 3.3.0
Environment: Apache Tinkerpop 3.3, Gremlin documentation
Reporter: Suhas Udeda
Priority: Minor
Fix For: 3.3.0
In the recipes section of Apache Tinkerpop web page, there is section dedicated
to computing the maximum depth of a node in a graph. According to the command
given there, maximum depth is includes the current node in its count as well.
While this is working fine for all the nodes, it fails when it comes to the
leaf nodes; it returns garbage value. This happens because of the placement of
emit() function in that command.
When I tried understanding how emit() function works, I could not find a
section dedicated to this function in the documentation. I believe this is a
shortcoming especially when beginners are trying to understand the
functionality by referring the documentation. It would be nice if a section can
be added for emit() and other such functions which lack their representation in
the documentation.
http://tinkerpop.apache.org/docs/current/recipes/#_maximum_depth
http://tinkerpop.apache.org/docs/3.3.0/reference/
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
