Skip to content

Clean up rxfire API documentation #2584

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
May 1, 2020
Merged

Clean up rxfire API documentation #2584

merged 3 commits into from
May 1, 2020

Conversation

shelcindra
Copy link
Contributor

@shelcindra shelcindra commented Jan 31, 2020 •
edited by jhuleatt
Loading

Closes #2572

All changes were made in firestore.
Made the following changes in separate commits:

  • Fixed format error so function parameters are now displayed. Also fixed function name in collectionData table.
  • Updated function descriptions (see questions below)
  • Cleaned up examples

Questions:
I'm not sure how good the new function descriptions are. I still have a few questions:

  • sortedChanges: says the function"emits the reduced state of individual changes". What does that mean?
  • sortedChanges: it isn't clear from the description how sortedChangesis different than collectionChanges. I wasn't able to clarify.

Thanks!

davideast
davideast approved these changes May 1, 2020
View reviewed changes
Copy link
Member

@davideast davideast left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is so much better than what we had before!

Thank you so much @shelcindra!

@davideast davideast merged commit ff53387 into firebase:master May 1, 2020
scottcrossen pushed a commit that referenced this pull request May 4, 2020
@shelcindra @scottcrossen
Clean up rxfire API documentation (#2584)
227b3af 
* Fixed markdown so parameters are visible in displayed tables for each function.

* Updated function descriptions.

* Updated examples.
@firebase firebase locked and limited conversation to collaborators Jun 1, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@davideast davideast davideast approved these changes

@jamesdaniels jamesdaniels Awaiting requested review from jamesdaniels

Assignees
No one assigned
Labels
RxFire
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Clean up RxFire's API documentation
3 participants
@shelcindra @davideast @jhuleatt