Skip to content

Commit

Permalink
Notice for renaming none() to discard() (apache#2408)
Browse files Browse the repository at this point in the history
Provides notice in release notes that none() will be renamed to discard() in TinkerPop 4.0
  • Loading branch information
ryn5 authored Dec 20, 2023
1 parent c21ad31 commit c28aa2e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ This release also includes changes from <<release-3-6-6, 3.6.6>> and <<release-3
* TINKERPOP-2830 Handle User-Agent from HTTP Requests to server
* TINKERPOP-2946 Resolve ordering issues in gherkin tests
* TINKERPOP-2951 Add translator to the Go GLV
* TINKERPOP-2964 Many TraversalParent's steps have a replaceLocalChild logic that can result in a new ChildTraversal having an ID that already exists.
* TINKERPOP-2964 Many TraversalParent's steps have a replaceLocalChild logic that can result in a new ChildTraversal having an ID that already exists.
* TINKERPOP-2978 Add List Manipulation Steps to Gremlin
* TINKERPOP-2979 Add Date Manipulation Steps to Gremlin
* TINKERPOP-2982 Allow gremlin-driver usage over HTTP
Expand Down
4 changes: 3 additions & 1 deletion docs/src/reference/the-traversal.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3148,13 +3148,15 @@ link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gre
[[none-step]]
=== None Step
The `none()`-step (*filter*) filters all objects from a traversal stream. It is especially useful for to traversals
The `none()`-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
quietly used by the `iterate()` terminal step which appends `none()` to the traversal before actually cycling through
results.
NOTE: As of release 4.0.0, `none()` will be renamed to `discard()`.
*Additional References*
link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/Traversal.html#none()++[`none()`]
Expand Down
6 changes: 6 additions & 0 deletions docs/src/upgrade/release-3.7.x.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,15 @@ complete list of all the modifications that are part of this release.
=== Upgrading for Users
==== Notice: Renaming `none()` step to `discard()` in 4.0.0
`none()`, which is primarily used by `iterate()` to discard traversal results in remote contexts, will be renamed to
`discard()` in release 4.0.0.
=== Upgrading for Providers
==== Notice: Renaming NoneStep to DiscardStep in 4.0.0
NoneStep, which is primarily used by `iterate()` to discard traversal results in remote contexts, will be renamed to
DiscardStep in release 4.0.0 to make room for a list filtering NoneStep.
== TinkerPop 3.7.1
*Release Date: November 20, 2023*
Expand Down

0 comments on commit c28aa2e

Please sign in to comment.