[jira] [Commented] (TINKERPOP-2392) Documentation for JavaScript library is non-existent

["ASF GitHub Bot (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/TINKERPOP-2392?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17187801#comment-17187801 ] 

ASF GitHub Bot commented on TINKERPOP-2392:
-------------------------------------------

spmallette opened a new pull request #1321:
URL: https://github.com/apache/tinkerpop/pull/1321


   https://issues.apache.org/jira/browse/TINKERPOP-2392
   
   This issue was about javascript but really might have applied to all GLVs. With the recent change of ae95dbe9c33b380555ee32716e56ec12b56c3f6c it seemed to make sense to expand this change to all GLVs and to improve upon it. I could have probably just CTR'd this in but thought it would be better to get some review on sample variety and syntax (as these changes will affect artifact repositories descriptions...nuget, pypi, npm...and I'm not sure there is a nice way to validate links/changes without a release deployment.
   
   VOTE +1


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> 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)