docs: Minor formatting (#11631)

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

Hide file tree

Showing 284 changed files with 4,563 additions and 406 deletions.
diff --git a/packages/google-cloud-bigquery-biglake/.flake8 b/packages/google-cloud-bigquery-biglake/.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-bigquery-biglake/CONTRIBUTING.rst b/packages/google-cloud-bigquery-biglake/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-bigquery-biglake/noxfile.py
 
 
 **********

diff --git a/packages/google-cloud-bigquery-biglake/MANIFEST.in b/packages/google-cloud-bigquery-biglake/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-bigquery-biglake/README.rst b/packages/google-cloud-bigquery-biglake/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-bigquery-biglake/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-bigquery-biglake
+    pip install google-cloud-bigquery-biglake
 
 
 Windows
 ^^^^^^^
 
 .. code-block:: console
 
-    pip install virtualenv
-    virtualenv <your-env>
-    <your-env>\Scripts\activate
-    <your-env>\Scripts\pip.exe install google-cloud-bigquery-biglake
+    py -m venv <your-env>
+    .\<your-env>\Scripts\activate
+    pip install google-cloud-bigquery-biglake
 
 Next Steps
 ~~~~~~~~~~

diff --git a/packages/google-cloud-bigquery-biglake/docs/conf.py b/packages/google-cloud-bigquery-biglake/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-bigquery-biglake/noxfile.py b/packages/google-cloud-bigquery-biglake/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-bigquery-biglake/scripts/decrypt-secrets.sh b/packages/google-cloud-bigquery-biglake/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/.../google-cloud-bigquery-data-exchange/google/cloud/bigquery_data_exchange/gapic_version.py b/.../google-cloud-bigquery-data-exchange/google/cloud/bigquery_data_exchange/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.5.5"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/...cloud-bigquery-data-exchange/google/cloud/bigquery_data_exchange_v1beta1/gapic_version.py b/...cloud-bigquery-data-exchange/google/cloud/bigquery_data_exchange_v1beta1/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.5.5"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/...oogle/cloud/bigquery_data_exchange_v1beta1/services/analytics_hub_service/async_client.py b/...oogle/cloud/bigquery_data_exchange_v1beta1/services/analytics_hub_service/async_client.py
@@ -414,6 +414,7 @@ async def sample_list_org_data_exchanges():
                 Message for response to listing data
                 exchanges in an organization and
                 location.
+
                 Iterating over this object will yield
                 results and resolve additional pages
                 automatically.
@@ -1463,6 +1464,7 @@ async def subscribe_listing(
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> dataexchange.SubscribeListingResponse:
         r"""Subscribes to a listing.
+
         Currently, with Analytics Hub, you can create listings
         that reference only BigQuery datasets.
         Upon subscription to a listing for a BigQuery dataset,

diff --git a/...ange/google/cloud/bigquery_data_exchange_v1beta1/services/analytics_hub_service/client.py b/...ange/google/cloud/bigquery_data_exchange_v1beta1/services/analytics_hub_service/client.py
@@ -675,6 +675,7 @@ def sample_list_org_data_exchanges():
                 Message for response to listing data
                 exchanges in an organization and
                 location.
+
                 Iterating over this object will yield
                 results and resolve additional pages
                 automatically.
@@ -1724,6 +1725,7 @@ def subscribe_listing(
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> dataexchange.SubscribeListingResponse:
         r"""Subscribes to a listing.
+
         Currently, with Analytics Hub, you can create listings
         that reference only BigQuery datasets.
         Upon subscription to a listing for a BigQuery dataset,

diff --git a/...le/cloud/bigquery_data_exchange_v1beta1/services/analytics_hub_service/transports/grpc.py b/...le/cloud/bigquery_data_exchange_v1beta1/services/analytics_hub_service/transports/grpc.py
@@ -542,6 +542,7 @@ def subscribe_listing(
         r"""Return a callable for the subscribe listing method over gRPC.
 
         Subscribes to a listing.
+
         Currently, with Analytics Hub, you can create listings
         that reference only BigQuery datasets.
         Upon subscription to a listing for a BigQuery dataset,

diff --git a/.../bigquery_data_exchange_v1beta1/services/analytics_hub_service/transports/grpc_asyncio.py b/.../bigquery_data_exchange_v1beta1/services/analytics_hub_service/transports/grpc_asyncio.py
@@ -553,6 +553,7 @@ def subscribe_listing(
         r"""Return a callable for the subscribe listing method over gRPC.
 
         Subscribes to a listing.
+
         Currently, with Analytics Hub, you can create listings
         that reference only BigQuery datasets.
         Upon subscription to a listing for a BigQuery dataset,

diff --git a/...-bigquery-data-exchange/google/cloud/bigquery_data_exchange_v1beta1/types/dataexchange.py b/...-bigquery-data-exchange/google/cloud/bigquery_data_exchange_v1beta1/types/dataexchange.py
@@ -85,11 +85,11 @@ class DataExchange(proto.Message):
             the data exchange.
         icon (bytes):
             Optional. Base64 encoded image representing
-            the data exchange. Max Size: 3.0MiB
-            Expected image dimensions are 512x512 pixels,
-            however the API only performs validation on size
-            of the encoded data. Note: For byte fields, the
-            content of the fields are base64-encoded (which
+            the data exchange. Max Size: 3.0MiB Expected
+            image dimensions are 512x512 pixels, however the
+            API only performs validation on size of the
+            encoded data. Note: For byte fields, the content
+            of the fields are base64-encoded (which
             increases the size of the data by 33-36%) when
             using JSON on the wire.
     """
@@ -286,13 +286,13 @@ class Listing(proto.Message):
             Output only. Current state of the listing.
         icon (bytes):
             Optional. Base64 encoded image representing
-            the listing. Max Size: 3.0MiB
-            Expected image dimensions are 512x512 pixels,
-            however the API only performs validation on size
-            of the encoded data. Note: For byte fields, the
-            contents of the field are base64-encoded (which
-            increases the size of the data by 33-36%) when
-            using JSON on the wire.
+            the listing. Max Size: 3.0MiB Expected image
+            dimensions are 512x512 pixels, however the API
+            only performs validation on size of the encoded
+            data. Note: For byte fields, the contents of the
+            field are base64-encoded (which increases the
+            size of the data by 33-36%) when using JSON on
+            the wire.
         data_provider (google.cloud.bigquery_data_exchange_v1beta1.types.DataProvider):
             Optional. Details of the data provider who
             owns the source data.

diff --git a/...amples/generated_samples/snippet_metadata_google.cloud.bigquery.dataexchange.v1beta1.json b/...amples/generated_samples/snippet_metadata_google.cloud.bigquery.dataexchange.v1beta1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-bigquery-data-exchange",
-    "version": "0.5.5"
+    "version": "0.1.0"
   },
   "snippets": [
     {

diff --git a/...es/google-cloud-bigquery-datapolicies/google/cloud/bigquery_datapolicies/gapic_version.py b/...es/google-cloud-bigquery-datapolicies/google/cloud/bigquery_datapolicies/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.6.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/...google-cloud-bigquery-datapolicies/google/cloud/bigquery_datapolicies_v1/gapic_version.py b/...google-cloud-bigquery-datapolicies/google/cloud/bigquery_datapolicies_v1/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.6.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/...e-cloud-bigquery-datapolicies/google/cloud/bigquery_datapolicies_v1beta1/gapic_version.py b/...e-cloud-bigquery-datapolicies/google/cloud/bigquery_datapolicies_v1beta1/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.6.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/...ies/samples/generated_samples/snippet_metadata_google.cloud.bigquery.datapolicies.v1.json b/...ies/samples/generated_samples/snippet_metadata_google.cloud.bigquery.datapolicies.v1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-bigquery-datapolicies",
-    "version": "0.6.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {

diff --git a/...amples/generated_samples/snippet_metadata_google.cloud.bigquery.datapolicies.v1beta1.json b/...amples/generated_samples/snippet_metadata_google.cloud.bigquery.datapolicies.v1beta1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-bigquery-datapolicies",
-    "version": "0.6.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {

diff --git a/packages/google-cloud-bigquery-logging/.flake8 b/packages/google-cloud-bigquery-logging/.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-bigquery-logging/CONTRIBUTING.rst b/packages/google-cloud-bigquery-logging/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-bigquery-logging/noxfile.py
 
 
 **********

diff --git a/packages/google-cloud-bigquery-logging/MANIFEST.in b/packages/google-cloud-bigquery-logging/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-bigquery-logging/README.rst b/packages/google-cloud-bigquery-logging/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-bigquery-logging/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-bigquery-logging
+    pip install google-cloud-bigquery-logging
 
 
 Windows
 ^^^^^^^
 
 .. code-block:: console
 
-    pip install virtualenv
-    virtualenv <your-env>
-    <your-env>\Scripts\activate
-    <your-env>\Scripts\pip.exe install google-cloud-bigquery-logging
+    py -m venv <your-env>
+    .\<your-env>\Scripts\activate
+    pip install google-cloud-bigquery-logging
 
 Next Steps
 ~~~~~~~~~~

diff --git a/packages/google-cloud-bigquery-logging/docs/conf.py b/packages/google-cloud-bigquery-logging/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-bigquery-logging/noxfile.py b/packages/google-cloud-bigquery-logging/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-bigquery-logging/scripts/decrypt-secrets.sh b/packages/google-cloud-bigquery-logging/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/packages/google-cloud-bigquery-migration/google/cloud/bigquery_migration/gapic_version.py b/packages/google-cloud-bigquery-migration/google/cloud/bigquery_migration/gapic_version.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2022 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.
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.11.1"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-bigquery-migration/google/cloud/bigquery_migration_v2/gapic_version.py b/packages/google-cloud-bigquery-migration/google/cloud/bigquery_migration_v2/gapic_version.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2022 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.
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.11.1"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/...le-cloud-bigquery-migration/google/cloud/bigquery_migration_v2/types/migration_metrics.py b/...le-cloud-bigquery-migration/google/cloud/bigquery_migration_v2/types/migration_metrics.py
@@ -39,6 +39,7 @@ class TimeSeries(proto.Message):
     Attributes:
         metric (str):
             Required. The name of the metric.
+
             If the metric is not known by the service yet,
             it will be auto-created.
         value_type (google.api.metric_pb2.ValueType):

diff --git a/...e-cloud-bigquery-migration/google/cloud/bigquery_migration_v2/types/translation_config.py b/...e-cloud-bigquery-migration/google/cloud/bigquery_migration_v2/types/translation_config.py
@@ -360,8 +360,7 @@ class MySQLDialect(proto.Message):
 
 class ObjectNameMappingList(proto.Message):
     r"""Represents a map of name mappings using a list of key:value
-    proto messages of
-    existing name to desired output name.
+    proto messages of existing name to desired output name.
 
     Attributes:
         name_map (MutableSequence[google.cloud.bigquery_migration_v2.types.ObjectNameMapping]):