Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ryn5 committed Dec 7, 2023
1 parent 7b52168 commit 177c306
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 19 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ image::https://raw.githubusercontent.com/apache/tinkerpop/master/docs/static/ima
* Added support for deserialization of `Set` for `gremlin-javascript`.
* Added integer overflow checks.
* Removed `none()`, which was deprecated in 3.7.2 in favor of `discard()`.
== TinkerPop 3.7.0 (Gremfir Master of the Pan Flute)
Expand Down
20 changes: 1 addition & 19 deletions docs/src/reference/the-traversal.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1451,7 +1451,7 @@ link:++https://tinkerpop.apache.org/docs/x.y.z/dev/provider/#difference-step++[`
[[discard-step]]
=== Discard Step
The `discard()`-step (*filter*) filters all objects from a traversal stream. It is especially useful for to traversals
The `discard()`-step (*filter*) filters all objects from a traversal stream. It is especially useful for 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
Expand Down Expand Up @@ -3160,24 +3160,6 @@ link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gre
link:++https://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:++https://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.
NOTE: As of release 3.7.2, `none()` has been deprecated in favor of `discard()` and is no longer used by `iterate()`.
*Additional References*
link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/Traversal.html#none()++[`discard()`]
link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/Traversal.html#discard()++[`discard()`]
link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/Traversal.html#iterate()++[`iterate()`]
[[not-step]]
=== Not Step
Expand Down
5 changes: 5 additions & 0 deletions docs/src/upgrade/release-4.x.x.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ skipped with incorrect result.
=== Upgrading for Providers
==== Renaming None Step to Discard
`none()`, which was deprecated in 3.7.2 favor of `discard()`, has been removed. In its place will be a new list
filtering step `none()`, which takes a predicate as an argument and passes lists with no elements matching the predicate.
==== Graph System Providers
==== Graph Driver Providers

0 comments on commit 177c306

Please sign in to comment.