Skip to content

Conversation

HemangChothani
Copy link
Contributor

Fixes: #9250

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Sep 24, 2019
@MaxxleLLC MaxxleLLC force-pushed the Firestore_change_documentation_on_snapshot branch from 1047ccd to b58daea Compare September 24, 2019 05:26
@MaxxleLLC MaxxleLLC force-pushed the Firestore_change_documentation_on_snapshot branch from b58daea to 7aff2ba Compare September 24, 2019 05:47
@HemangChothani HemangChothani changed the title Firestore: Clarify documentation for '{Document,Collection}.on_snapshot'. docs(firestore): add documentation for Document,Collection .on_snapshot Sep 24, 2019
@tseaver
Copy link
Contributor

tseaver commented Sep 24, 2019

Looking more closely, the Query.on_snapshot example is also incorrect: the first argument to the callback is a sorted list of keys / document paths in the updated tree. The example should illustrate how a real callback would handle all three arguments.

@crwilcox Please clarify / correct my understanding here, and suggest what a good callback example would look like.

@tseaver tseaver added the api: firestore Issues related to the Firestore API. label Sep 24, 2019
@tseaver tseaver changed the title docs(firestore): add documentation for Document,Collection .on_snapshot Firestore: Add documentation for '{Document,Collection}.on_snapshot'. Sep 24, 2019
@HemangChothani
Copy link
Contributor Author

@tseaver conventionalcommits.org check throws linting errors for title and give suggestion to edit your pull request title to match Conventional Commit guidelines, due to that i have changed the title.

@HemangChothani HemangChothani changed the title Firestore: Add documentation for '{Document,Collection}.on_snapshot'. docs(firestore): add documentation for Document,Collection .on_snapshot Sep 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: firestore Issues related to the Firestore API. cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Firestore: Clarify documentation for '{Document,Collection}.on_snapshot'.
4 participants