You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2016/12/16 15:55:42 UTC

[41/50] tinkerpop git commit: TINKERPOP-1490 Cleaned up documentation based on latest changes to promise API

TINKERPOP-1490 Cleaned up documentation based on latest changes to promise API


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

Branch: refs/heads/TINKERPOP-1490
Commit: 81fa7e0e19ad337d764f6bcb7c36c286ca33396d
Parents: 42e8588
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Mon Nov 14 06:38:18 2016 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Dec 16 10:00:40 2016 -0500

----------------------------------------------------------------------
 CHANGELOG.asciidoc                                 | 2 +-
 docs/src/upgrade/release-3.2.x-incubating.asciidoc | 4 +++-
 2 files changed, 4 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/81fa7e0e/CHANGELOG.asciidoc
----------------------------------------------------------------------
diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
index 24c75a7..b637552 100644
--- a/CHANGELOG.asciidoc
+++ b/CHANGELOG.asciidoc
@@ -52,7 +52,7 @@ TinkerPop 3.2.4 (Release Date: NOT OFFICIALLY RELEASED YET)
 * Factored `GremlinPlugin` functionality out of gremlin-groovy and into gremlin-core - related classes were deprecated.
 * Added a `force` option for killing sessions without waiting for transaction close or timeout of a currently running job or multiple jobs.
 * Deprecated `Session.kill()` and `Session.manualKill()`.
-* Added `Traversal.promise()` methods to allow for asynchronous traversal processing.
+* Added `Traversal.promise()` method to allow for asynchronous traversal processing on "remote" traversals.
 * Added `choose(predicate,traversal)` and `choose(traversal,traversal)` to effect if/then-semantics (no else). Equivalent to `choose(x,y,identity())`.
 * Removed `ImmutablePath.TailPath` as it is no longer required with new recursion model.
 * Removed call stack recursion in `ImmutablePath`.

http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/81fa7e0e/docs/src/upgrade/release-3.2.x-incubating.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/upgrade/release-3.2.x-incubating.asciidoc b/docs/src/upgrade/release-3.2.x-incubating.asciidoc
index 34ff427..428b0c6 100644
--- a/docs/src/upgrade/release-3.2.x-incubating.asciidoc
+++ b/docs/src/upgrade/release-3.2.x-incubating.asciidoc
@@ -35,7 +35,7 @@ Upgrading for Users
 Traversal Promises
 ^^^^^^^^^^^^^^^^^^
 
-The `Traversal` API now has two `promise()` method overloads. These methods return a promise in the form of a
+The `Traversal` API now has a new `promise()` method. These methods return a promise in the form of a
 `CompleteableFuture`. Usage is as follows:
 
 [source,groovy]
@@ -50,6 +50,8 @@ gremlin> g.V().out().promise{it.toList()}.thenApply{it.size()}.get()
 ==>6
 ----
 
+At this time, this method is only used for traversals that are configured using `withRemote()`.
+
 See: link:https://issues.apache.org/jira/browse/TINKERPOP-1490[TINKERPOP-1490]
 
 If/Then-Semantics with Choose Step