Repository: tinkerpop
Updated Branches:
  refs/heads/TINKERPOP-1975-x 19e723d94 -> 5e31cbc75


wip


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

Branch: refs/heads/TINKERPOP-1975-x
Commit: 5e31cbc75808e9d6941ae8e91b49677cced7825c
Parents: 19e723d
Author: Stephen Mallette <[email protected]>
Authored: Thu May 31 15:25:06 2018 -0400
Committer: Stephen Mallette <[email protected]>
Committed: Thu May 31 15:25:06 2018 -0400

----------------------------------------------------------------------
 docs/src/reference/the-traversal.asciidoc | 11 +++++++++--
 docs/src/upgrade/release-3.4.x.asciidoc   | 14 ++++++++++++++
 2 files changed, 23 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/5e31cbc7/docs/src/reference/the-traversal.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/the-traversal.asciidoc 
b/docs/src/reference/the-traversal.asciidoc
index 56384f7..4ded43e 100644
--- a/docs/src/reference/the-traversal.asciidoc
+++ b/docs/src/reference/the-traversal.asciidoc
@@ -1816,10 +1816,17 @@ IMPORTANT: The `peerPressure()`-step is a 
`VertexComputing`-step and as such, ca
 g = graph.traversal().withComputer()
 g.V().peerPressure().by('cluster').values('cluster')
 g.V().hasLabel('person').
-  peerPressure().by('cluster').
-  group().by('cluster').by('name')
+  peerPressure().
+    with(PeerPressure.PROPERTY_NAME, 'cluster').
+  group().
+    by('cluster').
+    by('name')
 ----
 
+Note the use of the `with()` modulating step which provides configuration 
options to the algorithm. It takes
+configuration keys from the static `PeerPressure` inner class on 
`PeerPressureVertexProgramStep` and is automatically
+imported to the Gremlin Console.
+
 *Additional References*
 
 
link:++http://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#peerPressure--++[`peerPressure()`]

http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/5e31cbc7/docs/src/upgrade/release-3.4.x.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/upgrade/release-3.4.x.asciidoc 
b/docs/src/upgrade/release-3.4.x.asciidoc
index 91668af..f99a6d5 100644
--- a/docs/src/upgrade/release-3.4.x.asciidoc
+++ b/docs/src/upgrade/release-3.4.x.asciidoc
@@ -47,6 +47,18 @@ g.V().hasLabel('person').
   valueMap('name','friendRank')
 ----
 
+A similar change was made for `peerPressure()` step:
+
+[groovy]
+----
+g.V().hasLabel('person').
+  peerPressure().
+    with(PeerPressure.PROPERTY_NAME, 'cluster').
+  group().
+    by('cluster').
+    by('name')
+----
+
 Note that the `by()` modulators still work, but should be considered 
deprecated and open for removal in a future
 release where breaking changes are allowed.
 
@@ -233,6 +245,8 @@ method could be removed in favor of the new 
`Configuring.configure()` method.
 All of the changes above basically mean, that if the `Mutating` interface was 
being used in prior versions, the
 `addPropertyMutations()` method simply needs to be changed to `configure()`.
 
+See: link:https://issues.apache.org/jira/browse/TINKERPOP-1975[TINKERPOP-1975]
+
 ===== Removed hadoop-gremlin Test Artifact
 
 The `hadoop-gremlin` module no longer generates a test jar that can be used as 
a test dependency in other modules.

Reply via email to