[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=17188375#comment-17188375 ] 

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

FlorianHockmann commented on a change in pull request #1321:
URL: https://github.com/apache/tinkerpop/pull/1321#discussion_r480962085



##########
File path: gremlin-dotnet/src/Gremlin.Net/Gremlin.Net.csproj
##########
@@ -42,10 +42,20 @@ http://tinkerpop.apache.org/docs/current/reference/#gremlin-server
 
 or a remote graph provider that exposes protocols by which Gremlin.Net can connect.
 
-Please see the reference documentation of Apache TinkerPop for more information on usage: https://s.apache.org/pgbwu
+Please see the Reference Documentation of Apache TinkerPop for more information on usage: http://tinkerpop.apache.org/docs/current/reference

Review comment:
       (nitpick) I think we can and should keep using `https` which also works for this link: https://tinkerpop.apache.org/docs/current/reference

##########
File path: gremlin-dotnet/README.md
##########
@@ -33,8 +33,22 @@ operating systems and with different .NET frameworks, such as .NET Framework and
 nuget install Gremlin.Net
 ```
 
-Please see the [reference documentation][docs] at Apache TinkerPop for more information.
+The Gremlin language allows users to write highly expressive graph traversals and has a broad list of functions that 
+cover a wide body of features. The [Reference Documentation][steps] describes these functions and other aspects of the 
+TinkerPop ecosystem including some specifics on [Gremlin in .NET][docs] itself. Most of the examples found in the 
+documentation use Groovy language syntax in the [Gremlin Console][console]. For the most part, these examples
+should generally translate to C# with [some logical modification][differences]. Given the strong correspondence 
+between canonical Gremlin in Java and its variants like C#, there is a limited amount of C#-specific 
+documentation and examples. This strong correspondence among variants ensures that the general Gremlin reference 
+documentation is applicable to all variants and that users moving between development languages can easily adopt the 
+Gremlin variant for that language.
+
+**NOTE** that versions suffixed with "-rc" are considered release candidates (i.e. pre-alpha, alpha, beta, etc.) and thus 
+for early testing purposes only.
 
 [tk]: http://tinkerpop.apache.org
 [gremlin]: http://tinkerpop.apache.org/gremlin.html
-[docs]: http://tinkerpop.apache.org/docs/current/reference/#gremlin-DotNet
\ No newline at end of file
+[docs]: http://tinkerpop.apache.org/docs/current/reference/#gremlin-dotnet

Review comment:
       Just a nit and not really related to this PR, but we can also upgrade these links to HTTPS now.

##########
File path: docs/src/reference/gremlin-variants.asciidoc
##########
@@ -1215,6 +1219,57 @@ and then it can be called from the application as follows:
 include::../../../gremlin-dotnet/test/Gremlin.Net.IntegrationTest/Docs/Reference/GremlinVariantsDslTests.cs[tags=dslExamples]
 ----
 
+[[gremlin-net-differences]]
+=== Differences
+
+The biggest difference between Gremlin in .NET and the canonical version in Java is the casing of steps. Canonical
+Gremlin utilizes `camelCase` as is typical in Java for function names, but C# utilizes `PascalCase` as it more typical

Review comment:
       _utilizes `PascalCase` as it more typical_ should probably be _utilizes `PascalCase` as it **is** more typical_.




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