Skip to content

docs(firestore): add documentation for Document,Collection .on_snapshot - #9275

Merged
crwilcox merged 2 commits into
googleapis:masterfrom
MaxxleLLC:Firestore_change_documentation_on_snapshot
Nov 7, 2019
Merged

docs(firestore): add documentation for Document,Collection .on_snapshot#9275
crwilcox merged 2 commits into
googleapis:masterfrom
MaxxleLLC:Firestore_change_documentation_on_snapshot

Conversation

@HemangChothani

Copy link
Copy Markdown
Contributor

Fixes: #9250

@googlebotgooglebot added the cla: yes This human has signed the Contributor License Agreement. label Sep 24, 2019
@MaxxleLLC
MaxxleLLCforce-pushed the Firestore_change_documentation_on_snapshot branch from 1047ccd to b58daeaCompareSeptember 24, 2019 05:26
@MaxxleLLC
MaxxleLLCforce-pushed the Firestore_change_documentation_on_snapshot branch from b58daea to 7aff2baCompareSeptember 24, 2019 05:47
@HemangChothaniHemangChothani changed the title Firestore: Clarify documentation for '{Document,Collection}.on_snapshot'.docs(firestore): add documentation for Document,Collection .on_snapshotSep 24, 2019
@tseaver

Copy link
Copy Markdown
Contributor

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.

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

Copy link
Copy Markdown
ContributorAuthor

@tseaverconventionalcommits.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.

@HemangChothaniHemangChothani changed the title Firestore: Add documentation for '{Document,Collection}.on_snapshot'.docs(firestore): add documentation for Document,Collection .on_snapshotSep 26, 2019
@crwilcox
crwilcox merged commit 879d9a1 into googleapis:masterNov 7, 2019
parthea pushed a commit that referenced this pull request Nov 24, 2025
…ot (#9275)
* add parameters in method on_snapshot of DocumentReference class
* docs: add parameters in method on-snapshot of Collection class
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: firestoreIssues related to the Firestore API.cla: yesThis 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

@HemangChothani@tseaver@crwilcox@googlebot