Uploaded image for project: 'Crunch'
  1. Crunch
  2. CRUNCH-623

Improve PTable#cogroup Javadoc

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.15.0
    • Component/s: Core
    • Labels:
      None

      Description

      The Javadoc for PTable#cogroup maybe confusing when comparing it to the PTable#join javadoc

        /**
         * Perform an inner join on this table and the one passed in as an argument on
         * their common keys.
         */
        <U> PTable<K, Pair<V, U>> join(PTable<K, U> other);
      
        /**
         * Co-group operation with the given table on common keys.
         */
        <U> PTable<K, Pair<Collection<V>, Collection<U>>> cogroup(PTable<K, U> other);
      

      The phrasing of "common keys" in the cogroup method make it sound like the cogroup will be a inner join on the table. I think removing the "common keys" from the cogroup method will remove that confusion.

        Attachments

          Activity

            People

            • Assignee:
              jwills Josh Wills
              Reporter:
              nathan.schile@gmail.com Nathan Schile
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: