docs: Fix formatting of request arg in docstring (#700)

* docs: Fix formatting of request arg in docstring chore: Update gapic-generator-python to v1.9.1 PiperOrigin-RevId: 518604533 Source-Link: googleapis/googleapis@8a085ae Source-Link: googleapis/googleapis-gen@b2ab4b0 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Mar 23, 2023 · 7b09f16 · 7b09f16
1 parent 16abc06
commit 7b09f16
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 28 deletions.
diff --git a/google/cloud/firestore_admin_v1/services/firestore_admin/async_client.py b/google/cloud/firestore_admin_v1/services/firestore_admin/async_client.py
@@ -1531,7 +1531,8 @@ async def sample_list_databases():
         Args:
             request (Optional[Union[google.cloud.firestore_admin_v1.types.ListDatabasesRequest, dict]]):
                 The request object. A request to list the Firestore
-                Databases in all locations for a project.
+                Databases in all locations for a
+                project.
             parent (:class:`str`):
                 Required. A parent name of the form
                 ``projects/{project_id}``

diff --git a/google/cloud/firestore_admin_v1/services/firestore_admin/client.py b/google/cloud/firestore_admin_v1/services/firestore_admin/client.py
@@ -1762,7 +1762,8 @@ def sample_list_databases():
         Args:
             request (Union[google.cloud.firestore_admin_v1.types.ListDatabasesRequest, dict]):
                 The request object. A request to list the Firestore
-                Databases in all locations for a project.
+                Databases in all locations for a
+                project.
             parent (str):
                 Required. A parent name of the form
                 ``projects/{project_id}``

diff --git a/google/cloud/firestore_admin_v1/services/firestore_admin/transports/rest.py b/google/cloud/firestore_admin_v1/services/firestore_admin/transports/rest.py
@@ -731,7 +731,6 @@ def __call__(
                 request (~.firestore_admin.CreateIndexRequest):
                     The request object. The request for
                 [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -829,7 +828,6 @@ def __call__(
                 request (~.firestore_admin.DeleteIndexRequest):
                     The request object. The request for
                 [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -905,7 +903,6 @@ def __call__(
                 request (~.firestore_admin.ExportDocumentsRequest):
                     The request object. The request for
                 [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1005,7 +1002,6 @@ def __call__(
                 request (~.firestore_admin.GetDatabaseRequest):
                     The request object. The request for
                 [FirestoreAdmin.GetDatabase][google.firestore.admin.v1.FirestoreAdmin.GetDatabase].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1096,7 +1092,6 @@ def __call__(
                 request (~.firestore_admin.GetFieldRequest):
                     The request object. The request for
                 [FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1189,7 +1184,6 @@ def __call__(
                 request (~.firestore_admin.GetIndexRequest):
                     The request object. The request for
                 [FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1280,7 +1274,6 @@ def __call__(
                 request (~.firestore_admin.ImportDocumentsRequest):
                     The request object. The request for
                 [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1381,7 +1374,6 @@ def __call__(
                     The request object. A request to list the Firestore
                 Databases in all locations for a
                 project.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1469,7 +1461,6 @@ def __call__(
                 request (~.firestore_admin.ListFieldsRequest):
                     The request object. The request for
                 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1559,7 +1550,6 @@ def __call__(
                 request (~.firestore_admin.ListIndexesRequest):
                     The request object. The request for
                 [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1649,7 +1639,6 @@ def __call__(
                 request (~.firestore_admin.UpdateDatabaseRequest):
                     The request object. The request for
                 [FirestoreAdmin.UpdateDatabase][google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1747,7 +1736,6 @@ def __call__(
                 request (~.firestore_admin.UpdateFieldRequest):
                     The request object. The request for
                 [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.

diff --git a/google/cloud/firestore_v1/services/firestore/async_client.py b/google/cloud/firestore_v1/services/firestore/async_client.py
@@ -1474,8 +1474,10 @@ def request_generator():
             requests (AsyncIterator[`google.cloud.firestore_v1.types.WriteRequest`]):
                 The request object AsyncIterator. The request for
                 [Firestore.Write][google.firestore.v1.Firestore.Write].
+
                 The first request creates a stream, or resumes an
                 existing one from a token.
+
                 When creating a new stream, the server replies with a
                 response containing only an ID and a token, to use in
                 the next request.

diff --git a/google/cloud/firestore_v1/services/firestore/client.py b/google/cloud/firestore_v1/services/firestore/client.py
@@ -1564,8 +1564,10 @@ def request_generator():
             requests (Iterator[google.cloud.firestore_v1.types.WriteRequest]):
                 The request object iterator. The request for
                 [Firestore.Write][google.firestore.v1.Firestore.Write].
+
                 The first request creates a stream, or resumes an
                 existing one from a token.
+
                 When creating a new stream, the server replies with a
                 response containing only an ID and a token, to use in
                 the next request.

diff --git a/google/cloud/firestore_v1/services/firestore/transports/rest.py b/google/cloud/firestore_v1/services/firestore/transports/rest.py
@@ -687,7 +687,6 @@ def __call__(
                 request (~.firestore.BatchGetDocumentsRequest):
                     The request object. The request for
                 [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -787,7 +786,6 @@ def __call__(
                 request (~.firestore.BatchWriteRequest):
                     The request object. The request for
                 [Firestore.BatchWrite][google.firestore.v1.Firestore.BatchWrite].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -886,7 +884,6 @@ def __call__(
                 request (~.firestore.BeginTransactionRequest):
                     The request object. The request for
                 [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -987,7 +984,6 @@ def __call__(
                 request (~.firestore.CommitRequest):
                     The request object. The request for
                 [Firestore.Commit][google.firestore.v1.Firestore.Commit].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1086,7 +1082,6 @@ def __call__(
                 request (~.firestore.CreateDocumentRequest):
                     The request object. The request for
                 [Firestore.CreateDocument][google.firestore.v1.Firestore.CreateDocument].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1185,7 +1180,6 @@ def __call__(
                 request (~.firestore.DeleteDocumentRequest):
                     The request object. The request for
                 [Firestore.DeleteDocument][google.firestore.v1.Firestore.DeleteDocument].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1261,7 +1255,6 @@ def __call__(
                 request (~.firestore.GetDocumentRequest):
                     The request object. The request for
                 [Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1351,7 +1344,6 @@ def __call__(
                 request (~.firestore.ListCollectionIdsRequest):
                     The request object. The request for
                 [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1457,7 +1449,6 @@ def __call__(
                 request (~.firestore.ListDocumentsRequest):
                     The request object. The request for
                 [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1567,7 +1558,6 @@ def __call__(
                 request (~.firestore.PartitionQueryRequest):
                     The request object. The request for
                 [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1671,7 +1661,6 @@ def __call__(
                 request (~.firestore.RollbackRequest):
                     The request object. The request for
                 [Firestore.Rollback][google.firestore.v1.Firestore.Rollback].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1756,7 +1745,6 @@ def __call__(
                 request (~.firestore.RunAggregationQueryRequest):
                     The request object. The request for
                 [Firestore.RunAggregationQuery][google.firestore.v1.Firestore.RunAggregationQuery].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1861,7 +1849,6 @@ def __call__(
                 request (~.firestore.RunQueryRequest):
                     The request object. The request for
                 [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1962,7 +1949,6 @@ def __call__(
                 request (~.firestore.UpdateDocumentRequest):
                     The request object. The request for
                 [Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.