docs: Minor formatting (#757)

gcf-owl-bot[bot] · vchudnov-g · daniel-sanche · web-flow · commit 41b5ea091245 · 2023-09-19T11:43:59.000-04:00
* docs: Minor formatting chore: Update gapic-generator-python to v1.11.5 build: Update rules_python to 0.24.0 PiperOrigin-RevId: 563436317 Source-Link: googleapis/googleapis@42fd37b Source-Link: googleapis/googleapis-gen@280264c Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 * 🦉 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> Co-authored-by: Victor Chudnovsky <vchudnov@google.com> Co-authored-by: Daniel Sanche <sanche@google.com>
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
@@ -54,7 +54,7 @@
 from google.cloud.firestore_admin_v1.types import index as gfa_index
 from google.cloud.firestore_admin_v1.types import operation as gfa_operation
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
+from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import empty_pb2  # type: ignore
 from google.protobuf import field_mask_pb2  # type: ignore
 from .transports.base import FirestoreAdminTransport, DEFAULT_CLIENT_INFO
@@ -1453,6 +1453,7 @@ async def sample_create_database():
                 database, which will become the final
                 component of the database's resource
                 name.
+
                 The value must be set to "(default)".
 
                 This corresponds to the ``database_id`` field
diff --git a/google/cloud/firestore_admin_v1/services/firestore_admin/client.py b/google/cloud/firestore_admin_v1/services/firestore_admin/client.py
@@ -58,7 +58,7 @@
 from google.cloud.firestore_admin_v1.types import index as gfa_index
 from google.cloud.firestore_admin_v1.types import operation as gfa_operation
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
+from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import empty_pb2  # type: ignore
 from google.protobuf import field_mask_pb2  # type: ignore
 from .transports.base import FirestoreAdminTransport, DEFAULT_CLIENT_INFO
@@ -1684,6 +1684,7 @@ def sample_create_database():
                 database, which will become the final
                 component of the database's resource
                 name.
+
                 The value must be set to "(default)".
 
                 This corresponds to the ``database_id`` field
diff --git a/google/cloud/firestore_admin_v1/services/firestore_admin/transports/base.py b/google/cloud/firestore_admin_v1/services/firestore_admin/transports/base.py
@@ -32,7 +32,6 @@
 from google.cloud.firestore_admin_v1.types import firestore_admin
 from google.cloud.firestore_admin_v1.types import index
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
 from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import empty_pb2  # type: ignore
 
diff --git a/google/cloud/firestore_admin_v1/services/firestore_admin/transports/grpc.py b/google/cloud/firestore_admin_v1/services/firestore_admin/transports/grpc.py
@@ -30,7 +30,6 @@
 from google.cloud.firestore_admin_v1.types import firestore_admin
 from google.cloud.firestore_admin_v1.types import index
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
 from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import empty_pb2  # type: ignore
 from .base import FirestoreAdminTransport, DEFAULT_CLIENT_INFO
diff --git a/google/cloud/firestore_admin_v1/services/firestore_admin/transports/grpc_asyncio.py b/google/cloud/firestore_admin_v1/services/firestore_admin/transports/grpc_asyncio.py
@@ -30,7 +30,6 @@
 from google.cloud.firestore_admin_v1.types import firestore_admin
 from google.cloud.firestore_admin_v1.types import index
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
 from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import empty_pb2  # type: ignore
 from .base import FirestoreAdminTransport, DEFAULT_CLIENT_INFO
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
@@ -29,7 +29,6 @@
 from google.protobuf import json_format
 from google.api_core import operations_v1
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
 from requests import __version__ as requests_version
 import dataclasses
 import re
@@ -46,8 +45,8 @@
 from google.cloud.firestore_admin_v1.types import field
 from google.cloud.firestore_admin_v1.types import firestore_admin
 from google.cloud.firestore_admin_v1.types import index
-from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import empty_pb2  # type: ignore
+from google.longrunning import operations_pb2  # type: ignore
 
 from .base import (
     FirestoreAdminTransport,
diff --git a/google/cloud/firestore_admin_v1/types/database.py b/google/cloud/firestore_admin_v1/types/database.py
@@ -104,12 +104,14 @@ class ConcurrencyMode(proto.Enum):
                 Use pessimistic concurrency control by
                 default. This mode is available for Cloud
                 Firestore databases.
+
                 This is the default setting for Cloud Firestore.
             OPTIMISTIC_WITH_ENTITY_GROUPS (3):
                 Use optimistic concurrency control with
                 entity groups by default.
                 This is the only available mode for Cloud
                 Datastore.
+
                 This mode is also available for Cloud Firestore
                 with Datastore Mode but is not recommended.
         """
diff --git a/google/cloud/firestore_admin_v1/types/field.py b/google/cloud/firestore_admin_v1/types/field.py
@@ -32,6 +32,7 @@
 
 class Field(proto.Message):
     r"""Represents a single field in the database.
+
     Fields are grouped by their "Collection Group", which represent
     all collections in the database with the same id.
 
diff --git a/google/cloud/firestore_admin_v1/types/firestore_admin.py b/google/cloud/firestore_admin_v1/types/firestore_admin.py
@@ -80,6 +80,7 @@ class CreateDatabaseRequest(proto.Message):
             Required. The ID to use for the database,
             which will become the final component of the
             database's resource name.
+
             The value must be set to "(default)".
     """
 
diff --git a/google/cloud/firestore_admin_v1/types/index.py b/google/cloud/firestore_admin_v1/types/index.py
@@ -44,6 +44,7 @@ class Index(proto.Message):
             that is the child of a specific document,
             specified at query time, and that has the same
             collection id.
+
             Indexes with a collection group query scope
             specified allow queries against all collections
             descended from a specific document, specified at
diff --git a/google/cloud/firestore_v1/services/firestore/async_client.py b/google/cloud/firestore_v1/services/firestore/async_client.py
@@ -54,7 +54,7 @@
 from google.cloud.firestore_v1.types import query
 from google.cloud.firestore_v1.types import write as gf_write
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
+from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import timestamp_pb2  # type: ignore
 from google.rpc import status_pb2  # type: ignore
 from .transports.base import FirestoreTransport, DEFAULT_CLIENT_INFO
@@ -64,6 +64,7 @@
 
 class FirestoreAsyncClient:
     """The Cloud Firestore service.
+
     Cloud Firestore is a fast, fully managed, serverless,
     cloud-native NoSQL document database that simplifies storing,
     syncing, and querying data for your mobile, web, and IoT apps at
@@ -276,6 +277,7 @@ async def sample_get_document():
         Returns:
             google.cloud.firestore_v1.types.Document:
                 A Firestore document.
+
                 Must not exceed 1 MiB - 4 bytes.
 
         """
@@ -483,6 +485,7 @@ async def sample_update_document():
                 The fields to update.
                 None of the field paths in the mask may
                 contain a reserved name.
+
                 If the document exists on the server and
                 has fields not referenced in the mask,
                 they are left unchanged.
@@ -502,6 +505,7 @@ async def sample_update_document():
         Returns:
             google.cloud.firestore_v1.types.Document:
                 A Firestore document.
+
                 Must not exceed 1 MiB - 4 bytes.
 
         """
@@ -673,6 +677,7 @@ def batch_get_documents(
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> Awaitable[AsyncIterable[firestore.BatchGetDocumentsResponse]]:
         r"""Gets multiple documents.
+
         Documents returned by this method are not guaranteed to
         be returned in the same order that they were requested.
 
@@ -926,6 +931,7 @@ async def sample_commit():
                 should not be set.
             writes (:class:`MutableSequence[google.cloud.firestore_v1.types.Write]`):
                 The writes to apply.
+
                 Always executed atomically and in order.
 
                 This corresponds to the ``writes`` field
@@ -1906,6 +1912,7 @@ async def sample_create_document():
         Returns:
             google.cloud.firestore_v1.types.Document:
                 A Firestore document.
+
                 Must not exceed 1 MiB - 4 bytes.
 
         """
diff --git a/google/cloud/firestore_v1/services/firestore/client.py b/google/cloud/firestore_v1/services/firestore/client.py
@@ -57,7 +57,7 @@
 from google.cloud.firestore_v1.types import query
 from google.cloud.firestore_v1.types import write as gf_write
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
+from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import timestamp_pb2  # type: ignore
 from google.rpc import status_pb2  # type: ignore
 from .transports.base import FirestoreTransport, DEFAULT_CLIENT_INFO
@@ -103,6 +103,7 @@ def get_transport_class(
 
 class FirestoreClient(metaclass=FirestoreClientMeta):
     """The Cloud Firestore service.
+
     Cloud Firestore is a fast, fully managed, serverless,
     cloud-native NoSQL document database that simplifies storing,
     syncing, and querying data for your mobile, web, and IoT apps at
@@ -488,6 +489,7 @@ def sample_get_document():
         Returns:
             google.cloud.firestore_v1.types.Document:
                 A Firestore document.
+
                 Must not exceed 1 MiB - 4 bytes.
 
         """
@@ -673,6 +675,7 @@ def sample_update_document():
                 The fields to update.
                 None of the field paths in the mask may
                 contain a reserved name.
+
                 If the document exists on the server and
                 has fields not referenced in the mask,
                 they are left unchanged.
@@ -692,6 +695,7 @@ def sample_update_document():
         Returns:
             google.cloud.firestore_v1.types.Document:
                 A Firestore document.
+
                 Must not exceed 1 MiB - 4 bytes.
 
         """
@@ -841,6 +845,7 @@ def batch_get_documents(
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> Iterable[firestore.BatchGetDocumentsResponse]:
         r"""Gets multiple documents.
+
         Documents returned by this method are not guaranteed to
         be returned in the same order that they were requested.
 
@@ -1071,6 +1076,7 @@ def sample_commit():
                 should not be set.
             writes (MutableSequence[google.cloud.firestore_v1.types.Write]):
                 The writes to apply.
+
                 Always executed atomically and in order.
 
                 This corresponds to the ``writes`` field
@@ -1954,6 +1960,7 @@ def sample_create_document():
         Returns:
             google.cloud.firestore_v1.types.Document:
                 A Firestore document.
+
                 Must not exceed 1 MiB - 4 bytes.
 
         """
diff --git a/google/cloud/firestore_v1/services/firestore/transports/base.py b/google/cloud/firestore_v1/services/firestore/transports/base.py
@@ -30,7 +30,7 @@
 from google.cloud.firestore_v1.types import document as gf_document
 from google.cloud.firestore_v1.types import firestore
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
+from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import empty_pb2  # type: ignore
 
 DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
diff --git a/google/cloud/firestore_v1/services/firestore/transports/grpc.py b/google/cloud/firestore_v1/services/firestore/transports/grpc.py
@@ -28,7 +28,7 @@
 from google.cloud.firestore_v1.types import document as gf_document
 from google.cloud.firestore_v1.types import firestore
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
+from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import empty_pb2  # type: ignore
 from .base import FirestoreTransport, DEFAULT_CLIENT_INFO
 
@@ -37,6 +37,7 @@ class FirestoreGrpcTransport(FirestoreTransport):
     """gRPC backend transport for Firestore.
 
     The Cloud Firestore service.
+
     Cloud Firestore is a fast, fully managed, serverless,
     cloud-native NoSQL document database that simplifies storing,
     syncing, and querying data for your mobile, web, and IoT apps at
@@ -354,6 +355,7 @@ def batch_get_documents(
         r"""Return a callable for the batch get documents method over gRPC.
 
         Gets multiple documents.
+
         Documents returned by this method are not guaranteed to
         be returned in the same order that they were requested.
 
diff --git a/google/cloud/firestore_v1/services/firestore/transports/grpc_asyncio.py b/google/cloud/firestore_v1/services/firestore/transports/grpc_asyncio.py
@@ -28,7 +28,7 @@
 from google.cloud.firestore_v1.types import document as gf_document
 from google.cloud.firestore_v1.types import firestore
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
+from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import empty_pb2  # type: ignore
 from .base import FirestoreTransport, DEFAULT_CLIENT_INFO
 from .grpc import FirestoreGrpcTransport
@@ -38,6 +38,7 @@ class FirestoreGrpcAsyncIOTransport(FirestoreTransport):
     """gRPC AsyncIO backend transport for Firestore.
 
     The Cloud Firestore service.
+
     Cloud Firestore is a fast, fully managed, serverless,
     cloud-native NoSQL document database that simplifies storing,
     syncing, and querying data for your mobile, web, and IoT apps at
@@ -360,6 +361,7 @@ def batch_get_documents(
         r"""Return a callable for the batch get documents method over gRPC.
 
         Gets multiple documents.
+
         Documents returned by this method are not guaranteed to
         be returned in the same order that they were requested.
 
diff --git a/google/cloud/firestore_v1/services/firestore/transports/rest.py b/google/cloud/firestore_v1/services/firestore/transports/rest.py
@@ -28,7 +28,6 @@
 
 from google.protobuf import json_format
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
 from requests import __version__ as requests_version
 import dataclasses
 import re
@@ -45,6 +44,7 @@
 from google.cloud.firestore_v1.types import document as gf_document
 from google.cloud.firestore_v1.types import firestore
 from google.protobuf import empty_pb2  # type: ignore
+from google.longrunning import operations_pb2  # type: ignore
 
 from .base import FirestoreTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO
 
@@ -567,6 +567,7 @@ class FirestoreRestTransport(FirestoreTransport):
     """REST backend transport for Firestore.
 
     The Cloud Firestore service.
+
     Cloud Firestore is a fast, fully managed, serverless,
     cloud-native NoSQL document database that simplifies storing,
     syncing, and querying data for your mobile, web, and IoT apps at
@@ -1091,6 +1092,7 @@ def __call__(
             Returns:
                 ~.document.Document:
                     A Firestore document.
+
                 Must not exceed 1 MiB - 4 bytes.
 
             """
@@ -1264,6 +1266,7 @@ def __call__(
             Returns:
                 ~.document.Document:
                     A Firestore document.
+
                 Must not exceed 1 MiB - 4 bytes.
 
             """
@@ -1958,6 +1961,7 @@ def __call__(
             Returns:
                 ~.gf_document.Document:
                     A Firestore document.
+
                 Must not exceed 1 MiB - 4 bytes.
 
             """
diff --git a/google/cloud/firestore_v1/types/common.py b/google/cloud/firestore_v1/types/common.py
@@ -139,6 +139,7 @@ class ReadOnly(proto.Message):
         Attributes:
             read_time (google.protobuf.timestamp_pb2.Timestamp):
                 Reads documents at the given time.
+
                 This must be a microsecond precision timestamp
                 within the past one hour, or if Point-in-Time
                 Recovery is enabled, can additionally be a whole
diff --git a/google/cloud/firestore_v1/types/document.py b/google/cloud/firestore_v1/types/document.py
@@ -37,6 +37,7 @@
 
 class Document(proto.Message):
     r"""A Firestore document.
+
     Must not exceed 1 MiB - 4 bytes.
 
     Attributes:
@@ -137,12 +138,14 @@ class Value(proto.Message):
             This field is a member of `oneof`_ ``value_type``.
         timestamp_value (google.protobuf.timestamp_pb2.Timestamp):
             A timestamp value.
+
             Precise only to microseconds. When stored, any
             additional precision is rounded down.
 
             This field is a member of `oneof`_ ``value_type``.
         string_value (str):
             A string value.
+
             The string, represented as UTF-8, must not
             exceed 1 MiB - 89 bytes. Only the first 1,500
             bytes of the UTF-8 representation are considered
@@ -151,6 +154,7 @@ class Value(proto.Message):
             This field is a member of `oneof`_ ``value_type``.
         bytes_value (bytes):
             A bytes value.
+
             Must not exceed 1 MiB - 89 bytes.
             Only the first 1,500 bytes are considered by
             queries.
@@ -168,6 +172,7 @@ class Value(proto.Message):
             This field is a member of `oneof`_ ``value_type``.
         array_value (google.cloud.firestore_v1.types.ArrayValue):
             An array value.
+
             Cannot directly contain another array value,
             though can contain an map which contains another
             array.
diff --git a/google/cloud/firestore_v1/types/firestore.py b/google/cloud/firestore_v1/types/firestore.py
diff --git a/google/cloud/firestore_v1/types/query.py b/google/cloud/firestore_v1/types/query.py
diff --git a/google/cloud/firestore_v1/types/write.py b/google/cloud/firestore_v1/types/write.py
diff --git a/tests/unit/gapic/firestore_admin_v1/test_firestore_admin.py b/tests/unit/gapic/firestore_admin_v1/test_firestore_admin.py
diff --git a/tests/unit/gapic/firestore_v1/test_firestore.py b/tests/unit/gapic/firestore_v1/test_firestore.py
