[jira] [Commented] (SAMZA-413) Correct and expand BlockingEnvelopMap javadoc

["David Chen (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SAMZA-413?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14133085#comment-14133085 ] 

David Chen commented on SAMZA-413:
----------------------------------

{code}
+  /**
+   * Place a collection of {@link org.apache.samza.system.IncomingMessageEnvelope}
+   * on the queue for the specified {@link org.apache.samza.system.SystemStreamPartition}.
+   * <p>
+   * Insertion of all the messags into the queue is not guaranteed to be done
+   * atomically.
+   *
+   * @param systemStreamPartition SystemStreamPartition that owns the envelope
+   * @param envelopes Messages for specified SystemStreamPartition
+   * @throws InterruptedException from underlying concurrent collection
+   */
{code}

 * "messags" is misspelled.
 * Does the {{<p>}} tag need a closing tag?

Other than these minor points, +1 (non-committer).

> Correct and expand BlockingEnvelopMap javadoc
> ---------------------------------------------
>
>                 Key: SAMZA-413
>                 URL: https://issues.apache.org/jira/browse/SAMZA-413
>             Project: Samza
>          Issue Type: Bug
>          Components: docs
>    Affects Versions: 0.7.0
>            Reporter: Jakob Homan
>            Assignee: Jakob Homan
>             Fix For: 0.8.0
>
>         Attachments: SAMZA-413.patch
>
>
> Javadoc header for BlockingEnvelopeMap refers to add and addAll rather than put and putAll.  Also, could use a bit of clarification on a couple of subtle points.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)