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/06/15 20:40:56 UTC

tinkerpop git commit: Added a NOTE to the centrality recipe to clarify the usage of by() CTR

Repository: tinkerpop
Updated Branches:
  refs/heads/master 6c1663255 -> b67db0c59


Added a NOTE to the centrality recipe to clarify the usage of by() CTR


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

Branch: refs/heads/master
Commit: b67db0c59dab49a1f4d008d21446c9136e8cbf41
Parents: 6c16632
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed Jun 15 16:40:27 2016 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed Jun 15 16:40:27 2016 -0400

----------------------------------------------------------------------
 docs/src/recipes/centrality.asciidoc | 6 ++++++
 1 file changed, 6 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/b67db0c5/docs/src/recipes/centrality.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/recipes/centrality.asciidoc b/docs/src/recipes/centrality.asciidoc
index e8d71e4..eeee79d 100644
--- a/docs/src/recipes/centrality.asciidoc
+++ b/docs/src/recipes/centrality.asciidoc
@@ -49,6 +49,12 @@ stream of `Map` objects can allow some greater flexibility.
 <5> For example, use of a stream enables use of an ordered limit that can be executed in a distributed fashion in
 OLAP traversals.
 
+NOTE: The link:http://tinkerpop.apache.org/docs/x.y.z/reference/#group-step[group] step takes up to two separate
+link:http://tinkerpop.apache.org/docs/x.y.z/reference/#by-step[by] modulators. The first `by()` tells `group()`
+what the key in the resulting `Map` will be (i.e. the value to group on). In the above examples, the `by()` is empty
+and as a result, the grouping will be on the incoming `Vertex` object itself. The second `by()` is the value to be
+stored in the `Map` for each key.
+
 [[betweeness-centrality]]
 Betweeness Centrality
 ~~~~~~~~~~~~~~~~~~~~~