FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs(firestore): add documentation for Document,Collection .on_snapshot by HemangChothani · Pull Request #9275 · googleapis/google-cloud-python · GitHub

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

Copy link
Copy Markdown
Contributor

Fixes: #9250

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Sep 24, 2019
MaxxleLLC force-pushed the Firestore_change_documentation_on_snapshot branch from 1047ccd to b58daea Compare September 24, 2019 05:26
MaxxleLLC force-pushed the Firestore_change_documentation_on_snapshot branch from b58daea to 7aff2ba Compare September 24, 2019 05:47
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 commented Sep 24, 2019

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.

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

Copy link
Copy Markdown
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 changed the title Firestore: Add documentation for '{Document,Collection}.on_snapshot'. docs(firestore): add documentation for Document,Collection .on_snapshot Sep 26, 2019
crwilcox merged commit 879d9a1 into googleapis:master Nov 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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


Back | FazBrowse Home | New Git URL