[
https://issues.apache.org/jira/browse/WAVE-271?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13034896#comment-13034896
]
David Hearnden commented on WAVE-271:
-------------------------------------
My suggestion:
/** Creates a new reply thread at the end of the document. */
ConversationThread addReplyThread();
/** Creates a new reply thread at a particular location. */
ConversationThread addReplyThread(int location);
"append" -> "add" because when inserting at a particular location, "append"
doesn't sound right, and addReplyThread() should just be shorthand for the 99%
use case of adding replies, which is addReplyThread(doc.size() - 1).
(I'd even be in favour of dropping the "Thread" suffix from those methods,
because it's already abundantly clear from the types that those objects are
threads, but I know that some people prefer the style of re-iterating types in
names).
> Review / rename ConversationBlip.appendInlineReplyThread(int location)
> ----------------------------------------------------------------------
>
> Key: WAVE-271
> URL: https://issues.apache.org/jira/browse/WAVE-271
> Project: Wave
> Issue Type: Task
> Reporter: Michael MacFadden
> Assignee: Michael MacFadden
> Priority: Minor
>
> The ConversationBlip defines these two methods:
> ConversationThread appendReplyThread();
> ConversationThread appendInlineReplyThread(int location);
> Since we have largely removed the distinction between inline threads and
> non-inline threads. These methods need to be reviewed. At first I had
> though of just renaming the second method to "ConversationThread
> appendInlineReplyThread(int location)", thereby just overloading the method.
> That still might be and option, but I thought we should actually review what
> these two methods do to see if we need to do anything other than renaming
> them. At the very least some better JavaDoc is probably a good idea.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira
