[
https://issues.apache.org/jira/browse/TINKERPOP-2392?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17158493#comment-17158493
]
Stephen Mallette commented on TINKERPOP-2392:
---------------------------------------------
The JS documentation is written on the assumption that you understand "Gremlin"
generally (largely by way of Gremlin Console) and then as a JS developer are
trying to find the specifics of how Gremlin in javascript works. It's currently
not written in such a way as to "learn Gremlin by way of JS" which sometimes
confuses those coming from non-JVM languages. Anyway, I'd agree that it could
be better - we've largely just struggled with how to make it better without
duplicating too much documentation and how to technically test code examples
for all language variants within the docs and then, of course, who has time to
invest energy into these efforts.
> Documentation for JavaScript library is non-existent
> ----------------------------------------------------
>
> Key: TINKERPOP-2392
> URL: https://issues.apache.org/jira/browse/TINKERPOP-2392
> Project: TinkerPop
> Issue Type: Improvement
> Components: javascript
> Affects Versions: 3.4.7
> Reporter: James Sumners
> Priority: Minor
>
> The readme for the JavaScript client says:
> "Please see the [reference
> documentation|http://tinkerpop.apache.org/docs/current/reference/#gremlin-javascript]
> at Apache TinkerPop for more information."
> That reference documentation is completely written in Groovy and does not
> translate well to JavaScript. At the very least, there should be some
> documentation that describes how to translate all of the globals used across
> the reference documentation. For example, in
> [http://tinkerpop.apache.org/docs/current/reference/#valuemap-step] it is
> suggested that one can translate the list based values to singular values by
> writing:
> ```
> g.V().valueMap().by(unfold())
> ```
> How do I translate this for usage in the JavaScript client? I assume the
> `unfold()` method needs to be attached to the instance referenced by the
> `by()` function. How do I get that reference easily? Can I pass a parameter
> like `.by( () => this.unfold() )` (it certainly doesn't work)? Neither
> `.by("unfold()")` nor `.by("unfold")` work.
> This sort of thing is present throughout the reference documentation and is
> making it very difficult to get up-to-speed with the JavaScript client.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
