docs: Minor formatting (#11633)

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: ohmayr <omairnaveed@ymail.com>
googleapis · Sep 11, 2023 · 1ae610b · 1ae610b
1 parent 9487380
commit 1ae610b
Show file tree

Hide file tree

Showing 248 changed files with 615 additions and 513 deletions.
diff --git a/packages/google-cloud-language/google/cloud/language/gapic_version.py b/packages/google-cloud-language/google/cloud/language/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.11.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-language/google/cloud/language_v1/gapic_version.py b/packages/google-cloud-language/google/cloud/language_v1/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.11.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-language/google/cloud/language_v1/types/language_service.py b/packages/google-cloud-language/google/cloud/language_v1/types/language_service.py
@@ -286,6 +286,7 @@ class Type(proto.Enum):
                 -  ``day`` - two digit day number, if detected
             NUMBER (12):
                 Number
+
                 The metadata is the number itself.
             PRICE (13):
                 Price

diff --git a/packages/google-cloud-language/google/cloud/language_v1beta2/gapic_version.py b/packages/google-cloud-language/google/cloud/language_v1beta2/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.11.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-language/google/cloud/language_v1beta2/types/language_service.py b/packages/google-cloud-language/google/cloud/language_v1beta2/types/language_service.py
@@ -322,6 +322,7 @@ class Type(proto.Enum):
                 -  ``day`` - two digit day number, if detected
             NUMBER (12):
                 Number
+
                 The metadata is the number itself.
             PRICE (13):
                 Price

diff --git a/packages/google-cloud-language/google/cloud/language_v2/gapic_version.py b/packages/google-cloud-language/google/cloud/language_v2/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.11.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-language/google/cloud/language_v2/types/language_service.py b/packages/google-cloud-language/google/cloud/language_v2/types/language_service.py
@@ -270,6 +270,7 @@ class Type(proto.Enum):
                 -  ``day`` - two digit day number, if detected
             NUMBER (12):
                 Number
+
                 The metadata is the number itself.
             PRICE (13):
                 Price

diff --git a/...e-cloud-language/samples/generated_samples/snippet_metadata_google.cloud.language.v1.json b/...e-cloud-language/samples/generated_samples/snippet_metadata_google.cloud.language.v1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-language",
-    "version": "2.11.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {

diff --git a/...ud-language/samples/generated_samples/snippet_metadata_google.cloud.language.v1beta2.json b/...ud-language/samples/generated_samples/snippet_metadata_google.cloud.language.v1beta2.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-language",
-    "version": "2.11.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {

diff --git a/...e-cloud-language/samples/generated_samples/snippet_metadata_google.cloud.language.v2.json b/...e-cloud-language/samples/generated_samples/snippet_metadata_google.cloud.language.v2.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-language",
-    "version": "2.11.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {

diff --git a/packages/google-cloud-life-sciences/.flake8 b/packages/google-cloud-life-sciences/.flake8
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2020 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/packages/google-cloud-life-sciences/CONTRIBUTING.rst b/packages/google-cloud-life-sciences/CONTRIBUTING.rst
@@ -236,7 +236,7 @@ We support:
 
 Supported versions can be found in our ``noxfile.py`` `config`_.
 
-.. _config: https://github.com/googleapis/google-cloud-python/blob/main/noxfile.py
+.. _config: https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-life-sciences/noxfile.py
 
 
 **********

diff --git a/packages/google-cloud-life-sciences/MANIFEST.in b/packages/google-cloud-life-sciences/MANIFEST.in
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2020 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/packages/google-cloud-life-sciences/README.rst b/packages/google-cloud-life-sciences/README.rst
@@ -36,21 +36,24 @@ In order to use this library, you first need to go through the following steps:
 Installation
 ~~~~~~~~~~~~
 
-Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
-create isolated Python environments. The basic problem it addresses is one of
-dependencies and versions, and indirectly permissions.
+Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
+creates isolated Python environments. These isolated environments can have separate
+versions of Python packages, which allows you to isolate one project's dependencies
+from the dependencies of other projects.
 
-With `virtualenv`_, it's possible to install this library without needing system
+With `venv`_, it's possible to install this library without needing system
 install permissions, and without clashing with the installed system
 dependencies.
 
-.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
+.. _`venv`: https://docs.python.org/3/library/venv.html
 
 
 Code samples and snippets
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Code samples and snippets live in the `samples/` folder.
+Code samples and snippets live in the `samples/`_ folder.
+
+.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-life-sciences/samples
 
 
 Supported Python Versions
@@ -77,21 +80,19 @@ Mac/Linux
 
 .. code-block:: console
 
-    pip install virtualenv
-    virtualenv <your-env>
+    python3 -m venv <your-env>
     source <your-env>/bin/activate
-    <your-env>/bin/pip install google-cloud-life-sciences
+    pip install google-cloud-life-sciences
 
 
 Windows
 ^^^^^^^
 
 .. code-block:: console
 
-    pip install virtualenv
-    virtualenv <your-env>
-    <your-env>\Scripts\activate
-    <your-env>\Scripts\pip.exe install google-cloud-life-sciences
+    py -m venv <your-env>
+    .\<your-env>\Scripts\activate
+    pip install google-cloud-life-sciences
 
 Next Steps
 ~~~~~~~~~~

diff --git a/packages/google-cloud-life-sciences/docs/conf.py b/packages/google-cloud-life-sciences/docs/conf.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2021 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/...ences/google/cloud/lifesciences_v2beta/services/workflows_service_v2_beta/async_client.py b/...ences/google/cloud/lifesciences_v2beta/services/workflows_service_v2_beta/async_client.py
@@ -45,7 +45,7 @@
 from google.api_core import operation  # type: ignore
 from google.api_core import operation_async  # type: ignore
 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.cloud.lifesciences_v2beta.types import workflows
 

diff --git a/...fe-sciences/google/cloud/lifesciences_v2beta/services/workflows_service_v2_beta/client.py b/...fe-sciences/google/cloud/lifesciences_v2beta/services/workflows_service_v2_beta/client.py
@@ -49,7 +49,7 @@
 from google.api_core import operation  # type: ignore
 from google.api_core import operation_async  # type: ignore
 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.cloud.lifesciences_v2beta.types import workflows
 

diff --git a/...es/google/cloud/lifesciences_v2beta/services/workflows_service_v2_beta/transports/rest.py b/...es/google/cloud/lifesciences_v2beta/services/workflows_service_v2_beta/transports/rest.py
@@ -33,7 +33,6 @@
 from google.auth.transport.grpc import SslCredentials  # type: ignore
 from google.auth.transport.requests import AuthorizedSession  # type: ignore
 from google.cloud.location import locations_pb2  # type: ignore
-from google.longrunning import operations_pb2
 from google.protobuf import json_format
 import grpc  # type: ignore
 from requests import __version__ as requests_version

diff --git a/packages/google-cloud-life-sciences/google/cloud/lifesciences_v2beta/types/workflows.py b/packages/google-cloud-life-sciences/google/cloud/lifesciences_v2beta/types/workflows.py
@@ -339,6 +339,7 @@ class Action(proto.Message):
             prevent typos in URIs or issues like lack of
             disk space from wasting large amounts of compute
             resources.
+
             If set, this flag prevents the worker from
             downloading the image until just before the
             action is executed.
@@ -498,6 +499,7 @@ class Mount(proto.Message):
 
 class Resources(proto.Message):
     r"""The system resources for the pipeline run.
+
     At least one zone or region must be specified or the pipeline
     run will fail.
 
@@ -583,6 +585,7 @@ class VirtualMachine(proto.Message):
             This parameter is only useful for carefully
             optimized work loads where the CPU platform has
             a significant impact.
+
             For more information about the effect of this
             parameter, see
             https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
@@ -920,6 +923,7 @@ class Volume(proto.Message):
 
 class PersistentDisk(proto.Message):
     r"""Configuration for a persistent disk to be attached to the VM.
+
     See https://cloud.google.com/compute/docs/disks/performance for
     more information about disk type, size, and performance
     considerations.

diff --git a/packages/google-cloud-life-sciences/noxfile.py b/packages/google-cloud-life-sciences/noxfile.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2018 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/packages/google-cloud-life-sciences/scripts/decrypt-secrets.sh b/packages/google-cloud-life-sciences/scripts/decrypt-secrets.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Copyright 2015 Google Inc. All rights reserved.
+# Copyright 2023 Google LLC All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/...loud-life-sciences/tests/unit/gapic/lifesciences_v2beta/test_workflows_service_v2_beta.py b/...loud-life-sciences/tests/unit/gapic/lifesciences_v2beta/test_workflows_service_v2_beta.py
@@ -42,7 +42,7 @@
 from google.auth import credentials as ga_credentials
 from google.auth.exceptions import MutualTLSChannelError
 from google.cloud.location import locations_pb2
-from google.longrunning import operations_pb2
+from google.longrunning import operations_pb2  # type: ignore
 from google.oauth2 import service_account
 from google.protobuf import duration_pb2  # type: ignore
 from google.protobuf import json_format

diff --git a/packages/google-cloud-managed-identities/.flake8 b/packages/google-cloud-managed-identities/.flake8
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2020 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/packages/google-cloud-managed-identities/CONTRIBUTING.rst b/packages/google-cloud-managed-identities/CONTRIBUTING.rst
@@ -236,7 +236,7 @@ We support:
 
 Supported versions can be found in our ``noxfile.py`` `config`_.
 
-.. _config: https://github.com/googleapis/google-cloud-python/blob/main/noxfile.py
+.. _config: https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-managed-identities/noxfile.py
 
 
 **********

diff --git a/packages/google-cloud-managed-identities/MANIFEST.in b/packages/google-cloud-managed-identities/MANIFEST.in
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2020 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/packages/google-cloud-managed-identities/README.rst b/packages/google-cloud-managed-identities/README.rst
@@ -36,21 +36,24 @@ In order to use this library, you first need to go through the following steps:
 Installation
 ~~~~~~~~~~~~
 
-Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
-create isolated Python environments. The basic problem it addresses is one of
-dependencies and versions, and indirectly permissions.
+Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
+creates isolated Python environments. These isolated environments can have separate
+versions of Python packages, which allows you to isolate one project's dependencies
+from the dependencies of other projects.
 
-With `virtualenv`_, it's possible to install this library without needing system
+With `venv`_, it's possible to install this library without needing system
 install permissions, and without clashing with the installed system
 dependencies.
 
-.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
+.. _`venv`: https://docs.python.org/3/library/venv.html
 
 
 Code samples and snippets
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Code samples and snippets live in the `samples/` folder.
+Code samples and snippets live in the `samples/`_ folder.
+
+.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-managed-identities/samples
 
 
 Supported Python Versions
@@ -77,21 +80,19 @@ Mac/Linux
 
 .. code-block:: console
 
-    pip install virtualenv
-    virtualenv <your-env>
+    python3 -m venv <your-env>
     source <your-env>/bin/activate
-    <your-env>/bin/pip install google-cloud-managed-identities
+    pip install google-cloud-managed-identities
 
 
 Windows
 ^^^^^^^
 
 .. code-block:: console
 
-    pip install virtualenv
-    virtualenv <your-env>
-    <your-env>\Scripts\activate
-    <your-env>\Scripts\pip.exe install google-cloud-managed-identities
+    py -m venv <your-env>
+    .\<your-env>\Scripts\activate
+    pip install google-cloud-managed-identities
 
 Next Steps
 ~~~~~~~~~~

diff --git a/packages/google-cloud-managed-identities/docs/conf.py b/packages/google-cloud-managed-identities/docs/conf.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2021 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/packages/google-cloud-managed-identities/noxfile.py b/packages/google-cloud-managed-identities/noxfile.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2018 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/packages/google-cloud-managed-identities/scripts/decrypt-secrets.sh b/packages/google-cloud-managed-identities/scripts/decrypt-secrets.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Copyright 2015 Google Inc. All rights reserved.
+# Copyright 2023 Google LLC All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/...naged-identities/tests/unit/gapic/managedidentities_v1/test_managed_identities_service.py b/...naged-identities/tests/unit/gapic/managedidentities_v1/test_managed_identities_service.py
@@ -39,7 +39,7 @@
 import google.auth
 from google.auth import credentials as ga_credentials
 from google.auth.exceptions import MutualTLSChannelError
-from google.longrunning import operations_pb2
+from google.longrunning import operations_pb2  # type: ignore
 from google.oauth2 import service_account
 from google.protobuf import empty_pb2  # type: ignore
 from google.protobuf import field_mask_pb2  # type: ignore

diff --git a/packages/google-cloud-media-translation/.flake8 b/packages/google-cloud-media-translation/.flake8
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2020 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/packages/google-cloud-media-translation/CONTRIBUTING.rst b/packages/google-cloud-media-translation/CONTRIBUTING.rst
@@ -236,7 +236,7 @@ We support:
 
 Supported versions can be found in our ``noxfile.py`` `config`_.
 
-.. _config: https://github.com/googleapis/google-cloud-python/blob/main/noxfile.py
+.. _config: https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-media-translation/noxfile.py
 
 
 **********

diff --git a/packages/google-cloud-media-translation/MANIFEST.in b/packages/google-cloud-media-translation/MANIFEST.in
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2020 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.