docs: restore undocumented classes after async split.

googleapis · Dec 15, 2020 · 9fdad0c · 9fdad0c
1 parent dffc580
commit 9fdad0c
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 0 deletions.
diff --git a/docs/batch.rst b/docs/batch.rst
@@ -1,6 +1,14 @@
 Batches
 ~~~~~~~
 
+.. automodule:: google.cloud.firestore_v1.base_batch
+  :members:
+  :show-inheritance:
+
 .. automodule:: google.cloud.firestore_v1.batch
   :members:
   :show-inheritance:
+
+.. automodule:: google.cloud.firestore_v1.async_batch
+  :members:
+  :show-inheritance:
diff --git a/docs/client.rst b/docs/client.rst
@@ -1,6 +1,14 @@
 Client
 ~~~~~~
 
+.. automodule:: google.cloud.firestore_v1.base_client
+  :members:
+  :show-inheritance:
+
 .. automodule:: google.cloud.firestore_v1.client
   :members:
   :show-inheritance:
+
+.. automodule:: google.cloud.firestore_v1.async_client
+  :members:
+  :show-inheritance:
diff --git a/docs/collection.rst b/docs/collection.rst
@@ -1,6 +1,14 @@
 Collections
 ~~~~~~~~~~~
 
+.. automodule:: google.cloud.firestore_v1.base_collection
+  :members:
+  :show-inheritance:
+
 .. automodule:: google.cloud.firestore_v1.collection
   :members:
   :show-inheritance:
+
+.. automodule:: google.cloud.firestore_v1.async_collection
+  :members:
+  :show-inheritance:
diff --git a/docs/document.rst b/docs/document.rst
@@ -1,6 +1,14 @@
 Documents
 ~~~~~~~~~
 
+.. automodule:: google.cloud.firestore_v1.base_document
+  :members:
+  :show-inheritance:
+
 .. automodule:: google.cloud.firestore_v1.document
   :members:
   :show-inheritance:
+
+.. automodule:: google.cloud.firestore_v1.async_document
+  :members:
+  :show-inheritance:
diff --git a/docs/query.rst b/docs/query.rst
@@ -1,6 +1,14 @@
 Queries
 ~~~~~~~
 
+.. automodule:: google.cloud.firestore_v1.base_query
+  :members:
+  :show-inheritance:
+
 .. automodule:: google.cloud.firestore_v1.query
   :members:
   :show-inheritance:
+
+.. automodule:: google.cloud.firestore_v1.async_query
+  :members:
+  :show-inheritance:
diff --git a/docs/transaction.rst b/docs/transaction.rst
@@ -1,7 +1,17 @@
 Transactions
 ~~~~~~~~~~~~
 
+.. automodule:: google.cloud.firestore_v1.base_transaction
+  :inherited-members:
+  :members:
+  :show-inheritance:
+
 .. automodule:: google.cloud.firestore_v1.transaction
   :inherited-members:
   :members:
   :show-inheritance:
+
+.. automodule:: google.cloud.firestore_v1.async_transaction
+  :inherited-members:
+  :members:
+  :show-inheritance:
diff --git a/google/cloud/firestore_v1/base_collection.py b/google/cloud/firestore_v1/base_collection.py
@@ -284,12 +284,15 @@ def limit(self, count: int) -> BaseQuery:
 
     def limit_to_last(self, count: int):
         """Create a limited to last query with this collection as parent.
+
         .. note::
            `limit` and `limit_to_last` are mutually exclusive.
            Setting `limit_to_last` will drop previously set `limit`.
+
         See
         :meth:`~google.cloud.firestore_v1.query.Query.limit_to_last`
         for more information on this method.
+
         Args:
             count (int): Maximum number of documents to return that
                 match the query.

diff --git a/google/cloud/firestore_v1/base_query.py b/google/cloud/firestore_v1/base_query.py
@@ -370,9 +370,11 @@ def limit(self, count: int) -> "BaseQuery":
         """Limit a query to return at most `count` matching results.
 
         If the current query already has a `limit` set, this will override it.
+
         .. note::
            `limit` and `limit_to_last` are mutually exclusive.
            Setting `limit` will drop previously set `limit_to_last`.
+
         Args:
             count (int): Maximum number of documents to return that match
                 the query.
@@ -398,9 +400,11 @@ def limit_to_last(self, count: int) -> "BaseQuery":
         """Limit a query to return the last `count` matching results.
         If the current query already has a `limit_to_last`
         set, this will override it.
+
         .. note::
            `limit` and `limit_to_last` are mutually exclusive.
            Setting `limit_to_last` will drop previously set `limit`.
+
         Args:
             count (int): Maximum number of documents to return that match
                 the query.