docs: Minor formatting fixes to reference documentation (#214)

* docs: Minor formatting fixes to reference documentation PiperOrigin-RevId: 499362676 Source-Link: googleapis/googleapis@870a5ed Source-Link: googleapis/googleapis-gen@4305362 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDMwNTM2MjNkNGZhODI4NWYzZDgyZWM3ZDhjOWI4ZjhjODQ5NWE2NCJ9 * 🦉 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 · Jan 4, 2023 · 17d8096 · 17d8096
1 parent b9be1e2
commit 17d8096
Show file tree

Hide file tree

Showing 12 changed files with 120 additions and 115 deletions.
diff --git a/google/cloud/notebooks_v1/services/managed_notebook_service/async_client.py b/google/cloud/notebooks_v1/services/managed_notebook_service/async_client.py
@@ -657,12 +657,12 @@ async def sample_update_runtime():
 
                 Currently, only the following fields can be updated:
 
-                -  software_config.kernels
-                -  software_config.post_startup_script
-                -  software_config.custom_gpu_driver_path
-                -  software_config.idle_shutdown
-                -  software_config.idle_shutdown_timeout
-                -  software_config.disable_terminal
+                -  ``software_config.kernels``
+                -  ``software_config.post_startup_script``
+                -  ``software_config.custom_gpu_driver_path``
+                -  ``software_config.idle_shutdown``
+                -  ``software_config.idle_shutdown_timeout``
+                -  ``software_config.disable_terminal``
 
                 This corresponds to the ``update_mask`` field
                 on the ``request`` instance; if ``request`` is provided, this

diff --git a/google/cloud/notebooks_v1/services/managed_notebook_service/client.py b/google/cloud/notebooks_v1/services/managed_notebook_service/client.py
@@ -881,12 +881,12 @@ def sample_update_runtime():
 
                 Currently, only the following fields can be updated:
 
-                -  software_config.kernels
-                -  software_config.post_startup_script
-                -  software_config.custom_gpu_driver_path
-                -  software_config.idle_shutdown
-                -  software_config.idle_shutdown_timeout
-                -  software_config.disable_terminal
+                -  ``software_config.kernels``
+                -  ``software_config.post_startup_script``
+                -  ``software_config.custom_gpu_driver_path``
+                -  ``software_config.idle_shutdown``
+                -  ``software_config.idle_shutdown_timeout``
+                -  ``software_config.disable_terminal``
 
                 This corresponds to the ``update_mask`` field
                 on the ``request`` instance; if ``request`` is provided, this

diff --git a/google/cloud/notebooks_v1/types/execution.py b/google/cloud/notebooks_v1/types/execution.py
@@ -227,22 +227,22 @@ class VertexAIParameters(proto.Message):
         Attributes:
             network (str):
                 The full name of the Compute Engine
-                `network </compute/docs/networks-and-firewalls#networks>`__
+                `network <https://cloud.google.com/compute/docs/networks-and-firewalls#networks>`__
                 to which the Job should be peered. For example,
                 ``projects/12345/global/networks/myVPC``.
                 `Format <https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert>`__
                 is of the form
                 ``projects/{project}/global/networks/{network}``. Where
-                {project} is a project number, as in ``12345``, and
-                {network} is a network name.
+                ``{project}`` is a project number, as in ``12345``, and
+                ``{network}`` is a network name.
 
                 Private services access must already be configured for the
                 network. If left unspecified, the job is not peered with any
                 network.
             env (MutableMapping[str, str]):
                 Environment variables. At most 100 environment variables can
                 be specified and unique. Example:
-                GCP_BUCKET=gs://my-bucket/samples/
+                ``GCP_BUCKET=gs://my-bucket/samples/``
         """
 
         network: str = proto.Field(

diff --git a/google/cloud/notebooks_v1/types/instance.py b/google/cloud/notebooks_v1/types/instance.py
@@ -128,12 +128,13 @@ class Instance(proto.Message):
                https://www.googleapis.com/auth/compute
         machine_type (str):
             Required. The `Compute Engine machine
-            type </compute/docs/machine-types>`__ of this instance.
+            type <https://cloud.google.com/compute/docs/machine-types>`__
+            of this instance.
         accelerator_config (google.cloud.notebooks_v1.types.Instance.AcceleratorConfig):
             The hardware accelerator used on this instance. If you use
             accelerators, make sure that your configuration has `enough
             vCPUs and memory to support the ``machine_type`` you have
-            selected </compute/docs/gpus/#gpus-list>`__.
+            selected <https://cloud.google.com/compute/docs/gpus/#gpus-list>`__.
         state (google.cloud.notebooks_v1.types.Instance.State):
             Output only. The state of this instance.
         install_gpu_driver (bool):
@@ -153,20 +154,20 @@ class Instance(proto.Message):
         boot_disk_size_gb (int):
             Input only. The size of the boot disk in GB
             attached to this instance, up to a maximum of
-            64000&nbsp;GB (64&nbsp;TB). The minimum
-            recommended value is 100&nbsp;GB. If not
-            specified, this defaults to 100.
+            64000 GB (64 TB). The minimum recommended value
+            is 100 GB. If not specified, this defaults to
+            100.
         data_disk_type (google.cloud.notebooks_v1.types.Instance.DiskType):
             Input only. The type of the data disk attached to this
             instance, defaults to standard persistent disk
             (``PD_STANDARD``).
         data_disk_size_gb (int):
             Input only. The size of the data disk in GB
             attached to this instance, up to a maximum of
-            64000&nbsp;GB (64&nbsp;TB). You can choose the
-            size of the data disk based on how big your
-            notebooks and data are. If not specified, this
-            defaults to 100.
+            64000 GB (64 TB). You can choose the size of the
+            data disk based on how big your notebooks and
+            data are. If not specified, this defaults to
+            100.
         no_remove_data_disk (bool):
             Input only. If true, the data disk will not
             be auto deleted when deleting the instance.
@@ -287,8 +288,8 @@ class NicType(proto.Enum):
     class AcceleratorConfig(proto.Message):
         r"""Definition of a hardware accelerator. Note that not all combinations
         of ``type`` and ``core_count`` are valid. Check `GPUs on Compute
-        Engine </compute/docs/gpus/#gpus-list>`__ to find a valid
-        combination. TPUs are not supported.
+        Engine <https://cloud.google.com/compute/docs/gpus/#gpus-list>`__ to
+        find a valid combination. TPUs are not supported.
 
         Attributes:
             type_ (google.cloud.notebooks_v1.types.Instance.AcceleratorType):
@@ -322,10 +323,10 @@ class Disk(proto.Message):
                 the disk for its root filesystem.
             device_name (str):
                 Indicates a unique device name of your choice that is
-                reflected into the /dev/disk/by-id/google-\* tree of a Linux
-                operating system running within the instance. This name can
-                be used to reference the device for mounting, resizing, and
-                so on, from within the instance.
+                reflected into the ``/dev/disk/by-id/google-*`` tree of a
+                Linux operating system running within the instance. This
+                name can be used to reference the device for mounting,
+                resizing, and so on, from within the instance.
 
                 If not specified, the server chooses a default device name
                 to apply to this disk, in the form persistent-disk-x, where
@@ -353,8 +354,8 @@ class Disk(proto.Message):
                 For performance characteristics of SCSI over NVMe, see Local
                 SSD performance. Valid values:
 
-                -  NVME
-                -  SCSI
+                -  ``NVME``
+                -  ``SCSI``
             kind (str):
                 Type of the resource. Always
                 compute#attachedDisk for attached disks.
@@ -364,21 +365,21 @@ class Disk(proto.Message):
                 and aggregate usage data for public and
                 marketplace images.
             mode (str):
-                The mode in which to attach this disk, either READ_WRITE or
-                READ_ONLY. If not specified, the default is to attach the
-                disk in READ_WRITE mode. Valid values:
+                The mode in which to attach this disk, either ``READ_WRITE``
+                or ``READ_ONLY``. If not specified, the default is to attach
+                the disk in ``READ_WRITE`` mode. Valid values:
 
-                -  READ_ONLY
-                -  READ_WRITE
+                -  ``READ_ONLY``
+                -  ``READ_WRITE``
             source (str):
                 Indicates a valid partial or full URL to an
                 existing Persistent Disk resource.
             type_ (str):
-                Indicates the type of the disk, either SCRATCH or
-                PERSISTENT. Valid values:
+                Indicates the type of the disk, either ``SCRATCH`` or
+                ``PERSISTENT``. Valid values:
 
-                -  PERSISTENT
-                -  SCRATCH
+                -  ``PERSISTENT``
+                -  ``SCRATCH``
         """
 
         class GuestOsFeature(proto.Message):
@@ -390,12 +391,12 @@ class GuestOsFeature(proto.Message):
                     system features to see a list of available options. Valid
                     values:
 
-                    -  FEATURE_TYPE_UNSPECIFIED
-                    -  MULTI_IP_SUBNET
-                    -  SECURE_BOOT
-                    -  UEFI_COMPATIBLE
-                    -  VIRTIO_SCSI_MULTIQUEUE
-                    -  WINDOWS
+                    -  ``FEATURE_TYPE_UNSPECIFIED``
+                    -  ``MULTI_IP_SUBNET``
+                    -  ``SECURE_BOOT``
+                    -  ``UEFI_COMPATIBLE``
+                    -  ``VIRTIO_SCSI_MULTIQUEUE``
+                    -  ``WINDOWS``
             """
 
             type_: str = proto.Field(
@@ -456,8 +457,10 @@ class GuestOsFeature(proto.Message):
         )
 
     class ShieldedInstanceConfig(proto.Message):
-        r"""A set of Shielded Instance options. Check [Images using supported
-        Shielded VM features] Not all combinations are valid.
+        r"""A set of Shielded Instance options. Check `Images using supported
+        Shielded VM
+        features <https://cloud.google.com/compute/docs/instances/modifying-shielded-vm>`__.
+        Not all combinations are valid.
 
         Attributes:
             enable_secure_boot (bool):
@@ -520,7 +523,7 @@ class UpgradeHistoryEntry(proto.Message):
                 entry is created.
             target_image (str):
                 Target VM Image. Format:
-                ainotebooks-vm/project/image-name/name.
+                ``ainotebooks-vm/project/image-name/name``.
             action (google.cloud.notebooks_v1.types.Instance.UpgradeHistoryEntry.Action):
                 Action. Rolloback or Upgrade.
             target_version (str):

diff --git a/google/cloud/notebooks_v1/types/managed_service.py b/google/cloud/notebooks_v1/types/managed_service.py
@@ -85,7 +85,7 @@ class ListRuntimesResponse(proto.Message):
             call.
         unreachable (MutableSequence[str]):
             Locations that could not be reached. For example,
-            ['us-west1', 'us-central1']. A ListRuntimesResponse will
+            ``['us-west1', 'us-central1']``. A ListRuntimesResponse will
             only contain either runtimes or unreachables,
     """
 
@@ -356,12 +356,12 @@ class UpdateRuntimeRequest(proto.Message):
 
             Currently, only the following fields can be updated:
 
-            -  software_config.kernels
-            -  software_config.post_startup_script
-            -  software_config.custom_gpu_driver_path
-            -  software_config.idle_shutdown
-            -  software_config.idle_shutdown_timeout
-            -  software_config.disable_terminal
+            -  ``software_config.kernels``
+            -  ``software_config.post_startup_script``
+            -  ``software_config.custom_gpu_driver_path``
+            -  ``software_config.idle_shutdown``
+            -  ``software_config.idle_shutdown_timeout``
+            -  ``software_config.disable_terminal``
         request_id (str):
             Idempotent request UUID.
     """

diff --git a/google/cloud/notebooks_v1/types/runtime.py b/google/cloud/notebooks_v1/types/runtime.py
@@ -220,8 +220,8 @@ class LocalDisk(proto.Message):
         device_name (str):
             Optional. Output only. Specifies a unique device name of
             your choice that is reflected into the
-            /dev/disk/by-id/google-\* tree of a Linux operating system
-            running within the instance. This name can be used to
+            ``/dev/disk/by-id/google-*`` tree of a Linux operating
+            system running within the instance. This name can be used to
             reference the device for mounting, resizing, and so on, from
             within the instance.
 
@@ -258,31 +258,31 @@ class LocalDisk(proto.Message):
             For performance characteristics of SCSI over NVMe, see Local
             SSD performance. Valid values:
 
-            -  NVME
-            -  SCSI
+            -  ``NVME``
+            -  ``SCSI``
         kind (str):
             Output only. Type of the resource. Always
             compute#attachedDisk for attached disks.
         licenses (MutableSequence[str]):
             Output only. Any valid publicly visible
             licenses.
         mode (str):
-            The mode in which to attach this disk, either READ_WRITE or
-            READ_ONLY. If not specified, the default is to attach the
-            disk in READ_WRITE mode. Valid values:
+            The mode in which to attach this disk, either ``READ_WRITE``
+            or ``READ_ONLY``. If not specified, the default is to attach
+            the disk in ``READ_WRITE`` mode. Valid values:
 
-            -  READ_ONLY
-            -  READ_WRITE
+            -  ``READ_ONLY``
+            -  ``READ_WRITE``
         source (str):
             Specifies a valid partial or full URL to an
             existing Persistent Disk resource.
         type_ (str):
-            Specifies the type of the disk, either SCRATCH or
-            PERSISTENT. If not specified, the default is PERSISTENT.
-            Valid values:
+            Specifies the type of the disk, either ``SCRATCH`` or
+            ``PERSISTENT``. If not specified, the default is
+            ``PERSISTENT``. Valid values:
 
-            -  PERSISTENT
-            -  SCRATCH
+            -  ``PERSISTENT``
+            -  ``SCRATCH``
     """
 
     class RuntimeGuestOsFeature(proto.Message):
@@ -301,12 +301,12 @@ class RuntimeGuestOsFeature(proto.Message):
 
                 Valid values:
 
-                -  FEATURE_TYPE_UNSPECIFIED
-                -  MULTI_IP_SUBNET
-                -  SECURE_BOOT
-                -  UEFI_COMPATIBLE
-                -  VIRTIO_SCSI_MULTIQUEUE
-                -  WINDOWS
+                -  ``FEATURE_TYPE_UNSPECIFIED``
+                -  ``MULTI_IP_SUBNET``
+                -  ``SECURE_BOOT``
+                -  ``UEFI_COMPATIBLE``
+                -  ``VIRTIO_SCSI_MULTIQUEUE``
+                -  ``WINDOWS``
         """
 
         type_: str = proto.Field(
@@ -776,15 +776,18 @@ class VirtualMachineConfig(proto.Message):
             The subnetwork allocation will use the range *name* if it's
             assigned.
 
-            | Example: managed-notebooks-range-c
-              PEERING_RANGE_NAME_3=managed-notebooks-range-c gcloud
-              compute addresses create $PEERING_RANGE_NAME_3
-            | --global
-            | --prefix-length=24
-            | --description="Google Cloud Managed Notebooks Range 24 c"
-            | --network=$NETWORK
-            | --addresses=192.168.0.0
-            | --purpose=VPC_PEERING
+            Example: managed-notebooks-range-c
+
+            ::
+
+                PEERING_RANGE_NAME_3=managed-notebooks-range-c
+                gcloud compute addresses create $PEERING_RANGE_NAME_3 \
+                  --global \
+                  --prefix-length=24 \
+                  --description="Google Cloud Managed Notebooks Range 24 c" \
+                  --network=$NETWORK \
+                  --addresses=192.168.0.0 \
+                  --purpose=VPC_PEERING
 
             Field value will be: ``managed-notebooks-range-c``
         boot_image (google.cloud.notebooks_v1.types.VirtualMachineConfig.BootImage):

diff --git a/google/cloud/notebooks_v1/types/schedule.py b/google/cloud/notebooks_v1/types/schedule.py
@@ -37,16 +37,16 @@ class Schedule(proto.Message):
             ``projects/{project_id}/locations/{location}/schedules/{schedule_id}``
         display_name (str):
             Output only. Display name used for UI purposes. Name can
-            only contain alphanumeric characters, hyphens '-', and
-            underscores '_'.
+            only contain alphanumeric characters, hyphens ``-``, and
+            underscores ``_``.
         description (str):
             A brief description of this environment.
         state (google.cloud.notebooks_v1.types.Schedule.State):
 
         cron_schedule (str):
             Cron-tab formatted schedule by which the job will execute.
             Format: minute, hour, day of month, month, day of week, e.g.
-            0 0 \* \* WED = every Wednesday More examples:
+            ``0 0 * * WED`` = every Wednesday More examples:
             https://crontab.guru/examples.html
         time_zone (str):
             Timezone on which the cron_schedule. The value of this field

diff --git a/google/cloud/notebooks_v1/types/service.py b/google/cloud/notebooks_v1/types/service.py
@@ -190,7 +190,7 @@ class ListInstancesResponse(proto.Message):
             call.
         unreachable (MutableSequence[str]):
             Locations that could not be reached. For example,
-            ['us-west1-a', 'us-central1-b']. A ListInstancesResponse
+            ``['us-west1-a', 'us-central1-b']``. A ListInstancesResponse
             will only contain either instances or unreachables,
     """
 
@@ -681,9 +681,8 @@ class RollbackInstanceRequest(proto.Message):
             Required. Format:
             ``projects/{project_id}/locations/{location}/instances/{instance_id}``
         target_snapshot (str):
-            Required. The snapshot for rollback.
-            Example:
-            "projects/test-project/global/snapshots/krwlzipynril".
+            Required. The snapshot for rollback. Example:
+            ``projects/test-project/global/snapshots/krwlzipynril``.
     """
 
     name: str = proto.Field(
@@ -1040,8 +1039,8 @@ class ListExecutionsRequest(proto.Message):
             used to continue listing from the last result.
         filter (str):
             Filter applied to resulting executions. Currently only
-            supports filtering executions by a specified schedule_id.
-            Format: ``schedule_id=<Schedule_ID>``
+            supports filtering executions by a specified
+            ``schedule_id``. Format: ``schedule_id=<Schedule_ID>``
         order_by (str):
             Sort by field.
     """