Skip to content
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.

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

docs: add documentation for documentsnapshot class #263

Merged
merged 6 commits into from Feb 5, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/document.rst
Expand Up @@ -4,3 +4,7 @@ Documents
.. automodule:: google.cloud.firestore_v1.document
:members:
:show-inheritance:

.. autoclass:: google.cloud.firestore_v1.base_document.DocumentSnapshot
:members:
:show-inheritance:
tseaver marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion google/cloud/firestore_v1/document.py
Expand Up @@ -420,7 +420,7 @@ def on_snapshot(self, callback: Callable) -> Watch:
provided callback is run on the snapshot.

Args:
callback(Callable[[:class:`~google.cloud.firestore.document.DocumentSnapshot`], NoneType]):
callback(Callable[[:class:`~google.cloud.firestore_v1.base_document.DocumentSnapshot`], NoneType]):
a callback to run when a change occurs

Example:
Expand Down