Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(operators): write comprehensive docs on delay() and switch() #1473

Closed
wants to merge 1 commit into from

Conversation

staltz
Copy link
Member

@staltz staltz commented Mar 15, 2016

Description:
I'm starting to document each operator in details and this first PR is just to demonstrate my general approach to document an operator. There are two operators documented here: delay and switch. The structure is:

  1. Short headline describing the operator
  2. Short "informal" description of the operator. Think of this as "the operator explained for dummies". Rx4 docs suffered from overly-technical and accurate descriptions which made it hard for normal humans to parse in their brains. I'm trying to provide both formal and informal descriptions.
  3. Marble diagram
  4. Longer formal/technical description
  5. Signature: params and return
  6. Example code that actually makes sense in the real world
  7. Link to the tests

Here is how delay and switch look like. @Blesh @trxcllnt @jhusain your feedback here is important, whether this structure is good. If it's good, I'll just go ahead and do this for all operators.

screen shot 2016-03-15 at 17 24 34

screen shot 2016-03-15 at 17 25 55

Related issue (if exists):
#1060, #1242

@staltz staltz force-pushed the better-operator-docs branch 2 times, most recently from db6065f to cfffd8e Compare March 15, 2016 15:38
@benlesh
Copy link
Member

benlesh commented Mar 16, 2016

Looks great, @staltz.

@frederikschubert
Copy link

I am relatively new to reactive programming and if all documentation was like your two examples it would have made my life much easier! 👍
Especially the cross-reference to mergeAll.
I would really like to have the similar operators referenced in the documentation.

@staltz
Copy link
Member Author

staltz commented Mar 17, 2016

Good point @frederikschubert

@staltz staltz force-pushed the better-operator-docs branch 3 times, most recently from 458c0ae to 8f4b375 Compare March 17, 2016 14:42
@benlesh
Copy link
Member

benlesh commented Mar 17, 2016

This is a point for later, but can we have higher-order observable link to a glossary somewhere that defines this for people? There are a lot of people who don't know what a "higher-order" function is.

Otherwise, LGTM.

@staltz
Copy link
Member Author

staltz commented Mar 18, 2016

Good point, and yes, let's do that.
ESDoc has non-customizable section structure, so we have to choose whether to put a guide on higher-order either in Manual or Tutorial. Anyway, it'll exist.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 95.982% when pulling a6a6798 on staltz:better-operator-docs into d9855e2 on ReactiveX:master.

@kwonoj
Copy link
Member

kwonoj commented Mar 18, 2016

Merged with 1c4f9f5, thanks @staltz

@kwonoj kwonoj closed this Mar 18, 2016
@staltz staltz deleted the better-operator-docs branch March 18, 2016 18:03
@lock
Copy link

lock bot commented Jun 7, 2018

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Jun 7, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants