You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by ok...@apache.org on 2015/11/18 15:30:44 UTC

[4/5] incubator-tinkerpop git commit: doc fix and added a reference to explain() in TraversalStrategy section. --dryRun showed it was good.

doc fix and added a reference to explain() in TraversalStrategy section. --dryRun showed it was good.


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

Branch: refs/heads/master
Commit: fe8cfa26b9137a7b3814f0f885ac6958feb0012f
Parents: 517f696
Author: Marko A. Rodriguez <ok...@gmail.com>
Authored: Tue Nov 17 14:31:16 2015 -0700
Committer: Marko A. Rodriguez <ok...@gmail.com>
Committed: Tue Nov 17 14:31:16 2015 -0700

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


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/fe8cfa26/docs/src/the-traversal.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/the-traversal.asciidoc b/docs/src/the-traversal.asciidoc
index d7134be..78619bb 100644
--- a/docs/src/the-traversal.asciidoc
+++ b/docs/src/the-traversal.asciidoc
@@ -592,7 +592,7 @@ post strategy application. The final traversal is the resultant execution plan.
 
 [gremlin-groovy,modern]
 ----
-g.V().outE().identity().inV().count().is(gt(5))
+g.V().outE().identity().inV().count().is(gt(5)).explain()
 ----
 
 For traversal profiling information, please see <<profile-step,`profile()`>>-step.
@@ -2124,6 +2124,8 @@ traversal as it deems fit. This is useful in multiple situations:
  * There are are some final adjustments required before executing the traversal (*finalization*).
  * There are certain traversals that are not legal for the application or traversal engine (*verification*).
 
+NOTE: The <<explain-step,`explain()`>>-step shows the user how each registered strategy mutates the traversal.
+
 A simple `OptimizationStrategy` is the `IdentityRemovalStrategy`.
 
 [source,java]