Firestore: Clarify documentation for '{Document,Collection}.on_snapshot'. #9250
Labels
api: firestore
Issues related to the Firestore API.
type: docs
Improvement to the documentation for an API.
on_snapshot
defined inDocumentReference
documentation is inconsistent with those ofWatch
and Product Documentation.In
DocumentReference
documentation, we havegoogle-cloud-python/firestore/google/cloud/firestore_v1/document.py
Lines 503 to 504 in f890d29
and
google-cloud-python/firestore/google/cloud/firestore_v1/document.py
Lines 515 to 517 in f890d29
In
Watch
documentation, we havegoogle-cloud-python/firestore/google/cloud/firestore_v1/watch.py
Lines 183 to 191 in f890d29
In Product Documentation, we have
The function signature in
DocumentReference
takes 1 argument, but the function signature in Watch and Product Documentation takes 3 arguments. Are these referring to the same function? If so, the documentation inDocumentReference
may be updated to reflect these changes. If not,on_snapshot
in Product Documentation may be renamed to a different name thanon_snapshot
inDocumentReference
to be more clear.Will probably submit a pull request to update documentation in
DocumentReference
to be consistent with that inWatch
.Thanks!
The text was updated successfully, but these errors were encountered: