mesos-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "John Sirois" <john.sir...@gmail.com>
Subject Re: Review Request 19859: Improve javadoc (use @param, @return, etc)
Date Tue, 01 Apr 2014 02:52:46 GMT

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/19859/#review39128
-----------------------------------------------------------

Ship it!


I have no power here, but this lgtm.

The final consideration would be precedent.  From the last file in the diff, thats as so:
* @param credentials Authentication credentials (e.g., "user:pass").

ie: no ascii art alignment, just * @param [name] [Sentence style description (init cap, period
end)].

I had a hard time with the . idea on @param when 1st presenter it but the explanation I was
given is it proves you finished your thought.  I'm ambivalent to a degree since @param are
rarely real sentences.
Consistency here might top the balance.


- John Sirois


On March 31, 2014, 8:33 p.m., Tobi Knaup wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/19859/
> -----------------------------------------------------------
> 
> (Updated March 31, 2014, 8:33 p.m.)
> 
> 
> Review request for mesos.
> 
> 
> Bugs: MESOS-135
>     https://issues.apache.org/jira/browse/MESOS-135
> 
> 
> Repository: mesos-git
> 
> 
> Description
> -------
> 
> See summary.
> There is a separate change in MESOS-570 to publish the docs on mesos.apache.org.
> 
> 
> Diffs
> -----
> 
>   src/java/src/org/apache/mesos/Executor.java 8f4eaee 
>   src/java/src/org/apache/mesos/ExecutorDriver.java cb14f38 
>   src/java/src/org/apache/mesos/Scheduler.java 55c4706 
>   src/java/src/org/apache/mesos/SchedulerDriver.java 6bca879 
>   src/java/src/org/apache/mesos/state/State.java dccb0ff 
>   src/java/src/org/apache/mesos/state/Variable.java bedb74b 
>   src/java/src/org/apache/mesos/state/ZooKeeperState.java f3d939f 
> 
> Diff: https://reviews.apache.org/r/19859/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tobi Knaup
> 
>


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message