javadoc improvements (groupJoin, groupByUntil, timestamp w/scheduler)

[DavidMGross]

adding marble diagrams and links to the RxJava wiki, standardizing javadoc comment formatting

[cloudbees-pull-request-builder]

RxJava-pull-requests #500 SUCCESS
This pull request looks good

[samuelgruetter]

@DavidMGross it would be nice to have a separate diagram for this overload of zip:

public static <R> Observable<R> zip(Observable<? extends Observable<?>> ws, FuncN<? extends R> zipFunction)

Today I wanted to explain this operator to some people, and a nice marble diagram for this would have been useful. As zipFunction, maybe just take a Func3 which puts its 3 arguments into one "box".

[DavidMGross]

I'll see what I can come up with.

On Fri, Dec 6, 2013 at 4:43 AM, samuelgruetter [email protected]:

@DavidMGross https://github.com/DavidMGross it would be nice to have a
separate diagram for this overload of zip:

public static Observable zip(Observable> ws, FuncN<? extends R> zipFunction)

Today I wanted to explain this operator to some people, and a nice marble
diagram for this would have been useful. As zipFunction, maybe just take
a Func3 which puts its 3 arguments into one "box".

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/569#issuecomment-29987282
.

David M. Gross
PLP Consulting

[DavidMGross]

How does this look?

https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/zip.o.png

On Fri, Dec 6, 2013 at 9:59 AM, PLP Consulting (David Gross) <
[email protected]> wrote:

I'll see what I can come up with.

On Fri, Dec 6, 2013 at 4:43 AM, samuelgruetter [email protected]:

@DavidMGross https://github.com/DavidMGross it would be nice to have a
separate diagram for this overload of zip:

public static Observable zip(Observable> ws, FuncN<? extends R> zipFunction)

Today I wanted to explain this operator to some people, and a nice marble
diagram for this would have been useful. As zipFunction, maybe just take
a Func3 which puts its 3 arguments into one "box".

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/569#issuecomment-29987282
.

David M. Gross
PLP Consulting

David M. Gross
PLP Consulting

[samuelgruetter]

Nice! Two ideas for improvement:

• Having the three observables overlap each other in time would make the diagram more instructive.
• --> binds stronger than , in most languages, so you really should add parentheses, ie. write zip{ ( cloud, circle, triangle ) --> triangle }, because otherwise it is read as zip{ cloud, circle, (triangle --> triangle) }. This confused me a lot, even though I already knew the semantics of the operator.

[DavidMGross]

Good suggestions. I'll see what I can do.

On Sun, Dec 8, 2013 at 7:12 AM, samuelgruetter [email protected]:

Nice! Two ideas for improvement:

• Having the three observables overlap each other in time would make
  the diagram more instructive.
• --> binds stronger than , in most languages, so you really should
  add parentheses, ie. write zip{ ( cloud, circle, triangle ) -->
  triangle }, because otherwise it is read as zip{ cloud, circle,
  (triangle --> triangle) }. This confused me a lot, even though I
  already knew the semantics of the operator.

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/569#issuecomment-30083438
.

David M. Gross
PLP Consulting