[30/45] tinkerpop git commit: TINKERPOP-786 Added a note to docs about generic naming

[sp...@apache.org]

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/911d17fe
Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/911d17fe
Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/911d17fe

Branch: refs/heads/tp32-glv
Commit: 911d17fe09aa16304c386b8e031ec9a677751be7
Parents: e0505d1
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed May 10 15:27:56 2017 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Tue May 16 11:02:31 2017 -0400

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


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/911d17fe/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.