This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
The following commit(s) were added to refs/heads/master by this push:
new 6e14309 Added none() step to traversal docs CTR
new d8a0db6 Merge branch 'tp33'
6e14309 is described below
commit 6e14309169bf7dd502b38f2ea4b55ab8881cecb2
Author: Stephen Mallette <[email protected]>
AuthorDate: Tue Nov 20 08:48:11 2018 -0500
Added none() step to traversal docs CTR
---
docs/src/reference/the-traversal.asciidoc | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/docs/src/reference/the-traversal.asciidoc
b/docs/src/reference/the-traversal.asciidoc
index 20c4fc8..46b21f6 100644
--- a/docs/src/reference/the-traversal.asciidoc
+++ b/docs/src/reference/the-traversal.asciidoc
@@ -1563,6 +1563,21 @@
link:++http://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/grem
link:++http://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#min-org.apache.tinkerpop.gremlin.process.traversal.Scope-++[`min(Scope)`],
link:++http://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/Scope.html++[`Scope`]
+[[none-step]]
+=== None Step
+
+The `none()`-step (*filter*) filters all objects from a traversal stream. It
is especially useful for to traversals
+that are executed remotely where returning results is not useful and the
traversal is only meant to generate
+side-effects. Choosing not to return results saves in serialization and
network costs as the objects are filtered on
+the remote end and not returned to the client side. Typically, this step does
not need to be used directly and is
+quietly used by the `iterate()` terminal step which appends `none()` to the
traversal before actually cycling through
+results.
+
+*Additional References*
+
+link:++http://tinkerpop.apache.org/javadocs/current/core/org/apache/tinkerpop/gremlin/process/traversal/Traversal.html#none--++['none()']
+link:++http://tinkerpop.apache.org/javadocs/current/core/org/apache/tinkerpop/gremlin/process/traversal/Traversal.html#iterate--++['iterate()']
+
[[not-step]]
=== Not Step
