[
https://issues.apache.org/jira/browse/TINKERPOP-1552?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16050503#comment-16050503
]
ASF GitHub Bot commented on TINKERPOP-1552:
-------------------------------------------
GitHub user FlorianHockmann opened a pull request:
https://github.com/apache/tinkerpop/pull/627
TINKERPOP-1552: Improve comments in Gremlin-DotNet
https://issues.apache.org/jira/browse/TINKERPOP-1552
This change adds many comments to Gremlin-DotNet, especially for the GLV
part. Some comments where taken from the respective Java classes. It also adds
comments to most of the auto-generated methods to tell the user what the method
does.
Example for the anonymous class `__`:
```cs
/// <summary>
/// Spawns a <see cref="GraphTraversal{SType, EType}" /> and adds the
out step to that traversal.
/// </summary>
public static GraphTraversal<object, Vertex> Out(params object[] args)
{
return new GraphTraversal<object, object>().Out(args);
}
```
And for a `GraphTraversal` step:
```cs
/// <summary>
/// Adds the aggregate step to this <see cref="GraphTraversal{SType,
EType}" />.
/// </summary>
public GraphTraversal< S , E > Aggregate (params object[] args)
{
Bytecode.AddStep("aggregate", args);
return Wrap< S , E >(this);
}
```
Apart from the comment improvements, this also marks
`GraphTraversalSource.WithBindings` as obsolete as it is also marked as
deprecated in Gremlin-Java.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/FlorianHockmann/tinkerpop dotnet-glv-comments
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/tinkerpop/pull/627.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #627
----
commit a0e6c22324ec078053afa14f5123a729002f60db
Author: Florian Hockmann <[email protected]>
Date: 2017-06-15T13:09:58Z
Improve comments in Gremlin-DotNet, especially for the GLV part
----
> C# Gremlin Language Variant
> ---------------------------
>
> Key: TINKERPOP-1552
> URL: https://issues.apache.org/jira/browse/TINKERPOP-1552
> Project: TinkerPop
> Issue Type: Improvement
> Components: language-variant
> Affects Versions: 3.2.3
> Reporter: Jorge Bay
> Assignee: stephen mallette
>
> It would be nice to have a C# GLV that runs under .NET Framework 4.5+ and
> .NET Core.
> The maven build could use the Exec Maven Plugin to exec .NET Core's [dotnet
> test|https://www.microsoft.com/net/core#macos] command.
> Some requirements, from the mailing list (edited):
> {quote}
> 1. The GLV should keep in line with class/method names of the java API
> where possible to ensure consistency of feel across languages.
> 2. There needs to be adequate tests (we're still discussing the approach to
> testing GLVs and i think that needs to be tackled sooner than later as more
> GLVs start to come in). Those tests should produce xunit style output
> unless there is some good reason not to.
> 3. There needs to be adequate documentation (e.g. Reference docs)
> 4. The build/deploy process needs to be bound to maven which might be one of
> the trickier bits to deal with.
> {quote}
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
