From 7edc6821cdfde4ec9fcac0ed88b4d4ccdaf203f8 Mon Sep 17 00:00:00 2001 From: HemangChothani Date: Fri, 27 Nov 2020 13:50:09 +0530 Subject: [PATCH 1/2] docs: add documentation for documentsnapshot class --- docs/document.rst | 4 ++++ google/cloud/firestore_v1/document.py | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/document.rst b/docs/document.rst index bc04dd4443..d0a1f32cd3 100644 --- a/docs/document.rst +++ b/docs/document.rst @@ -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: diff --git a/google/cloud/firestore_v1/document.py b/google/cloud/firestore_v1/document.py index bdb5c7943b..b20d6054bd 100644 --- a/google/cloud/firestore_v1/document.py +++ b/google/cloud/firestore_v1/document.py @@ -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: From dbacb0829de8b851f4fb7fe97d207c04e96ec18d Mon Sep 17 00:00:00 2001 From: Tres Seaver Date: Wed, 3 Feb 2021 12:49:21 -0500 Subject: [PATCH 2/2] chore: drop superseded docs fix See PR #278. --- docs/document.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/document.rst b/docs/document.rst index d0a1f32cd3..bc04dd4443 100644 --- a/docs/document.rst +++ b/docs/document.rst @@ -4,7 +4,3 @@ Documents .. automodule:: google.cloud.firestore_v1.document :members: :show-inheritance: - -.. autoclass:: google.cloud.firestore_v1.base_document.DocumentSnapshot - :members: - :show-inheritance: