crunch git commit: CRUNCH-623: Improves Javadoc of PTable#cogroup

[jw...@apache.org]

Repository: crunch
Updated Branches:
  refs/heads/master e8d2a69b6 -> 5944f81b2


CRUNCH-623: Improves Javadoc of PTable#cogroup

Signed-off-by: Josh Wills <jw...@apache.org>


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

Branch: refs/heads/master
Commit: 5944f81b2aa15c59484d24864570d21e13bfca3b
Parents: e8d2a69
Author: Nathan Schile <na...@cerner.com>
Authored: Thu Sep 29 16:24:14 2016 -0500
Committer: Josh Wills <jw...@apache.org>
Committed: Mon Oct 10 09:28:38 2016 -0700

----------------------------------------------------------------------
 crunch-core/src/main/java/org/apache/crunch/PTable.java | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/crunch/blob/5944f81b/crunch-core/src/main/java/org/apache/crunch/PTable.java
----------------------------------------------------------------------
diff --git a/crunch-core/src/main/java/org/apache/crunch/PTable.java b/crunch-core/src/main/java/org/apache/crunch/PTable.java
index 74cade8..114c655 100644
--- a/crunch-core/src/main/java/org/apache/crunch/PTable.java
+++ b/crunch-core/src/main/java/org/apache/crunch/PTable.java
@@ -171,7 +171,10 @@ public interface PTable<K, V> extends PCollection<Pair<K, V>> {
   <U> PTable<K, Pair<V, U>> join(PTable<K, U> other);
 
   /**
-   * Co-group operation with the given table on common keys.
+   * Co-group operation with the given table.
+   * <p>
+   * <b>Note:</b> If the given table contains keys that are not present in this PTable, an empty
+   * PCollection is set for the relationship.
    */
   <U> PTable<K, Pair<Collection<V>, Collection<U>>> cogroup(PTable<K, U> other);