You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by dk...@apache.org on 2015/09/03 19:51:29 UTC

[02/50] [abbrv] incubator-tinkerpop git commit: Add describeSteps() method to docs.

Add describeSteps() method to docs.


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

Branch: refs/heads/blvp
Commit: 54dcfc9df41ce66ef54607b1cc7a6240e693fece
Parents: 57bf98c
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Tue Aug 18 12:25:11 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Tue Aug 18 12:25:11 2015 -0400

----------------------------------------------------------------------
 docs/src/gremlin-applications.asciidoc | 13 +++++++++++++
 1 file changed, 13 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/54dcfc9d/docs/src/gremlin-applications.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/gremlin-applications.asciidoc b/docs/src/gremlin-applications.asciidoc
index 5b653b2..a64e626 100644
--- a/docs/src/gremlin-applications.asciidoc
+++ b/docs/src/gremlin-applications.asciidoc
@@ -1256,3 +1256,16 @@ A good implementation of the Gremlin APIs will validate their features against t
 ----
 describeGraph(HadoopGraph)
 ----
+
+[[describe-steps]]
+Describe Steps
+^^^^^^^^^^^^^^
+
+Gremlin steps are building blocks of the Gremlin language.  In most cases, a step will extend from a number of basic abstract steps that provide most of the functionality for a step of the implemented type.  A step will also possibly implement one or more marker interfaces that don't enforce any functionality, but provide more runtime information about how to classify it.  As there are many steps and many base steps and markers, it can be hard for those writing `TraversalStrategy` implementations to keep track of them all.
+
+The `describeSteps` function helps with this problem by generating a table that contains a list of all steps on the classpath and indicators that show which base classes and markers are associated with them.
+
+[gremlin-groovy,modern]
+----
+describeSteps()
+----
\ No newline at end of file