Repository: tinkerpop
Updated Branches:
  refs/heads/tp32 97947c1a6 -> 56245ced6


TINKERPOP-1842 Added some documentation around iterate() CTR


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

Branch: refs/heads/tp32
Commit: 56245ced6da32301b1a9a1a915bfd7daa1e8f24a
Parents: 97947c1
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Mon Feb 12 12:19:36 2018 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Mon Feb 12 12:19:36 2018 -0500

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


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/56245ced/docs/src/reference/the-traversal.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/the-traversal.asciidoc 
b/docs/src/reference/the-traversal.asciidoc
index 2433597..69bc8a3 100644
--- a/docs/src/reference/the-traversal.asciidoc
+++ b/docs/src/reference/the-traversal.asciidoc
@@ -159,6 +159,7 @@ g.V().out('created').toSet() <6>
 g.V().out('created').toBulkSet() <7>
 results = ['blah',3]
 g.V().out('created').fill(results) <8>
+g.addV('person').iterate() <9>
 ----
 
 <1> `hasNext()` determines whether there are available results.
@@ -169,6 +170,9 @@ g.V().out('created').fill(results) <8>
 <6> `toSet()` will return all results in a set (thus, duplicates removed).
 <7> `toBulkSet()` will return all results in a weighted set (thus, duplicates 
preserved via weighting).
 <8> `fill(collection)` will put all results in the provided collection and 
return the collection when complete.
+<9> `iterate()` does not exactly fit the definition of a terminal step in that 
it doesn't return a result, but still
+returns a traversal - it does however behave as a terminal step in that it 
iterates the traversal and generates side
+effects without returning the actual result.
 
 Finally, <<explain-step,`explain()`>>-step is also a terminal step and is 
described in its own section.
 

Reply via email to