tinkerpop git commit: TINKERPOP-786 Added a note to docs about generic naming

[sp...@apache.org]

Repository: tinkerpop
Updated Branches:
  refs/heads/TINKERPOP-786 850ba099d -> d0d540f3f


TINKERPOP-786 Added a note to docs about generic naming


Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/d0d540f3
Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/d0d540f3
Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/d0d540f3

Branch: refs/heads/TINKERPOP-786
Commit: d0d540f3fb3ff8c82bb5956023ba88dcd8c993e7
Parents: 850ba09
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed May 10 15:27:56 2017 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed May 10 15:27:56 2017 -0400

----------------------------------------------------------------------
 docs/src/reference/the-traversal.asciidoc | 3 +++
 1 file changed, 3 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/d0d540f3/docs/src/reference/the-traversal.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/the-traversal.asciidoc b/docs/src/reference/the-traversal.asciidoc
index 7da4015..ec0bed9 100644
--- a/docs/src/reference/the-traversal.asciidoc
+++ b/docs/src/reference/the-traversal.asciidoc
@@ -3008,6 +3008,9 @@ public interface SocialTraversalDsl<S, E> extends GraphTraversal.Admin<S, E> {
 }
 ----
 
+IMPORTANT: Follow the TinkerPop convention of using `<S,E>` in naming generics as those conventions are taken into
+account when generating the anonymous traversal class.
+
 The `@GremlinDsl` annotation is used by the link:https://docs.oracle.com/javase/8/docs/api/index.html?javax/annotation/processing/Processor.html[Java Annotation Processor]
 to generate the boilerplate class structure required to properly use the DSL within the TinkerPop framework. These
 classes can be generated and maintained by hand, but it would be time consuming, monotonous and error-prone to do so.