[GitHub] tinkerpop pull request #629: TINKERPOP-1552: Clean-up Gremlin-DotNet project...

[asfgit]

Github user asfgit closed the pull request at:

https://github.com/apache/tinkerpop/pull/629


---
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 infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop pull request #629: TINKERPOP-1552: Clean-up Gremlin-DotNet project...

[FlorianHockmann]

Github user FlorianHockmann commented on a diff in the pull request:

https://github.com/apache/tinkerpop/pull/629#discussion_r122460079
  
--- Diff: gremlin-dotnet/glv/AnonymousTraversal.template ---
@@ -27,6 +27,8 @@ using Gremlin.Net.Structure;
 // THIS IS A GENERATED FILE - DO NOT MODIFY THIS FILE DIRECTLY - see 
pom.xml
 namespace Gremlin.Net.Process.Traversal
 {
+#pragma warning disable 1591
--- End diff --

Done.


---
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 infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop pull request #629: TINKERPOP-1552: Clean-up Gremlin-DotNet project...

[FlorianHockmann]

Github user FlorianHockmann commented on a diff in the pull request:

https://github.com/apache/tinkerpop/pull/629#discussion_r122388282
  
--- Diff: gremlin-dotnet/glv/AnonymousTraversal.template ---
@@ -27,6 +27,8 @@ using Gremlin.Net.Structure;
 // THIS IS A GENERATED FILE - DO NOT MODIFY THIS FILE DIRECTLY - see 
pom.xml
 namespace Gremlin.Net.Process.Traversal
 {
+#pragma warning disable 1591
--- End diff --

Looks like you're right. I thought that it would be necessary to also 
document all function arguments and return values, but it seems to be enough to 
have a `summary` for each element. This also applies to the `GraphTraversal` 
class. I'll update the pull request to remove the `pragmas` for both classes.


---
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 infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop pull request #629: TINKERPOP-1552: Clean-up Gremlin-DotNet project...

[jorgebay]

Github user jorgebay commented on a diff in the pull request:

https://github.com/apache/tinkerpop/pull/629#discussion_r122383928
  
--- Diff: gremlin-dotnet/glv/AnonymousTraversal.template ---
@@ -27,6 +27,8 @@ using Gremlin.Net.Structure;
 // THIS IS A GENERATED FILE - DO NOT MODIFY THIS FILE DIRECTLY - see 
pom.xml
 namespace Gremlin.Net.Process.Traversal
 {
+#pragma warning disable 1591
--- End diff --

Is this needed for this source file, all methods are being generated with 
docs.


---
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 infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop pull request #629: TINKERPOP-1552: Clean-up Gremlin-DotNet project...

[FlorianHockmann]

GitHub user FlorianHockmann opened a pull request:

https://github.com/apache/tinkerpop/pull/629

TINKERPOP-1552: Clean-up Gremlin-DotNet project files

https://issues.apache.org/jira/browse/TINKERPOP-1552

This removes some obsolete configuration options and improves the package 
meta information. Especially the description was extended to reflect the 
current state of Gremlin-DotNet. This explanation can be removed as soon as the 
old Gremlin.Net driver is obsolete (probably when a first release version of 
Gremlin-DotNet is released).
The version is now 3.2.5-beta1.

I also enabled the generation of an XML document containing the 
documentation comments which will be displayed to the user with IntelliSense. 
The warning about missing comments had to be disabled for some files as we 
currently just don't have comments for those. I think that's ok for now, but we 
should try to find a way to create meaningful comments where they are missing 
right now for the first official (non-beta) release.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/FlorianHockmann/tinkerpop 
gremlin-dotnet-packagemetadata

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/tinkerpop/pull/629.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 #629


commit 02955d4df4c1e16ec3fcd6977979badc44a8b91e
Author: Florian Hockmann 
Date:   2017-06-15T16:25:56Z

Clean-up Gremlin-DotNet project files

This removes some obsolete configuration options and improves the package 
meta information. Especially the description was extended to reflect the 
current state of Gremlin-DotNet. This explanation can be removed as soon as the 
old Gremlin.Net driver is obsolete (probably when a first release version of 
Gremlin-DotNet is released).
The version is now 3.2.5-beta1.

commit ab55e95de63efc6d670a7af50901f9c48a33501d
Author: Florian Hockmann 
Date:   2017-06-15T17:00:38Z

Let Gremlin-DotNet include the documentation comments

Every build now generates an XML document containing the documentation 
comments which will be displayed to the user with IntelliSense. The warning 
about missing comments had to be disabled for some files as we currently just 
don't have comments for those.




---
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 infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---