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

Improve PTable#cogroup Javadoc

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Trivial
    • Resolution: Fixed
    • None
    • 0.15.0
    • Core
    • 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

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

            Dates

              Created:
              Updated:
              Resolved: