[jira] [Comment Edited] (TINKERPOP-1816) Consider improvements to the .NET documentation

["Bill Woo (JIRA)" <ji...@apache.org>]

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

Bill Woo edited comment on TINKERPOP-1816 at 10/26/17 1:01 PM:
---------------------------------------------------------------

Without a certain minimal level of documentation, there is nothing to improve.

If it one could infer the syntax of the .NET port from the other platform examples with reasonable effort, improvement of the .NET port would be doable, but, this is clearly not the case.

In most cases, Visual Studio intellisense is quite helpful, but, in the ,NET port, the use of non-mnemonic identifiers makes things more difficult, and the source code has almost no comments.

I suggest you remove the .NET port until it is minimally useful without "stumbling around."


was (Author: bwoo):
Without a certain minimal level of documentation, there is nothing to improve.

If it one could infer the syntax of the .NET port from the other platform examples with reasonable effort, improvement of the .NET port would be doable, but, this is clearly not the case.

I suggest you remove the .NET port until it is minimally useful without "stumbling around."

> Consider improvements to the .NET documentation
> -----------------------------------------------
>
>                 Key: TINKERPOP-1816
>                 URL: https://issues.apache.org/jira/browse/TINKERPOP-1816
>             Project: TinkerPop
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 3.2.6
>            Reporter: Bill Woo
>            Priority: Minor
>
> Without at least one complete code sample, you are wasting potential users; time.
> How do you run a query/traversal ?  
> By "stumbling around in the dark" I was able to get this far:
>             private Graph graph = new Graph();
>             private GraphTraversalSource g;
>             // in method body
>             g = graph.Traversal().WithRemote(new DriverRemoteConnection(new GremlinClient(new GremlinServer("localhost", 8182))));
>             
>             Vertex v1 = new Vertex("Bill");
>             g.AddV(v1);
>             Vertex v2 = new Vertex("Julie");
>             g.AddV(v2);
>             Edge e1 = new Edge("e1", v1, "Knows", v2);
>             g.AddE(e1);
>             VertexProperty p1 = new VertexProperty("p1","BillProp", "TestProp", v1);



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)