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
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
