Skip to content
This repository was archived by the owner on Sep 5, 2023. It is now read-only.

Commit f122cb0

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Fix broken links and formatting in the reference documentation (#93)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 400904467 Source-Link: googleapis/googleapis@701a095 Source-Link: https://github.com/googleapis/googleapis-gen/commit/fb14cf0233249447597803374b4bfc757d967356 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZmIxNGNmMDIzMzI0OTQ0NzU5NzgwMzM3NGI0YmZjNzU3ZDk2NzM1NiJ9
1 parent 0c2aa04 commit f122cb0

5 files changed

Lines changed: 29 additions & 26 deletions

File tree

‎google/cloud/notebooks_v1/types/execution.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ class ExecutionTemplate(proto.Message):
9191
input_notebook_file (str):
9292
Path to the notebook file to execute. Must be in a Google
9393
Cloud Storage bucket. Format:
94-
gs://{project_id}/{folder}/{notebook_file_name} Ex:
95-
gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
94+
``gs://{project_id}/{folder}/{notebook_file_name}`` Ex:
95+
``gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb``
9696
container_image_uri (str):
9797
Container Image URI to a DLVM
9898
Example: 'gcr.io/deeplearning-platform-
@@ -103,15 +103,15 @@ class ExecutionTemplate(proto.Message):
103103
output_notebook_folder (str):
104104
Path to the notebook folder to write to. Must be in a Google
105105
Cloud Storage bucket path. Format:
106-
gs://{project_id}/{folder} Ex:
107-
gs://notebook_user/scheduled_notebooks
106+
``gs://{project_id}/{folder}`` Ex:
107+
``gs://notebook_user/scheduled_notebooks``
108108
params_yaml_file (str):
109109
Parameters to be overridden in the notebook during
110110
execution. Ref
111111
https://papermill.readthedocs.io/en/latest/usage-parameterize.html
112112
on how to specifying parameters in the input notebook and
113113
pass them here in an YAML file. Ex:
114-
gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
114+
``gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml``
115115
parameters (str):
116116
Parameters used within the 'input_notebook_file' notebook.
117117
service_account (str):
@@ -177,7 +177,7 @@ class DataprocParameters(proto.Message):
177177
Attributes:
178178
cluster (str):
179179
URI for cluster used to run Dataproc execution. Format:
180-
'projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}
180+
``projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}``
181181
"""
182182

183183
cluster = proto.Field(proto.STRING, number=1,)
@@ -208,7 +208,7 @@ class Execution(proto.Message):
208208
spec, region, labels, etc.
209209
name (str):
210210
Output only. The resource name of the execute. Format:
211-
\`projects/{project_id}/locations/{location}/execution/{execution_id}
211+
``projects/{project_id}/locations/{location}/execution/{execution_id}``
212212
display_name (str):
213213
Output only. Name used for UI purposes. Name can only
214214
contain alphanumeric characters and underscores '_'.

‎google/cloud/notebooks_v1/types/instance.py‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,9 @@ class Instance(proto.Message):
6666
Use a container image to start the notebook
6767
instance.
6868
post_startup_script (str):
69-
Path to a Bash script that automatically runs
70-
after a notebook instance fully boots up. The
71-
path must be a URL or Cloud Storage path
72-
(gs://path-to-file/file-name).
69+
Path to a Bash script that automatically runs after a
70+
notebook instance fully boots up. The path must be a URL or
71+
Cloud Storage path (``gs://path-to-file/file-name``).
7372
proxy_uri (str):
7473
Output only. The proxy endpoint that is used
7574
to access the Jupyter notebook.
@@ -159,9 +158,9 @@ class Instance(proto.Message):
159158
Output only. Attached disks to notebook
160159
instance.
161160
shielded_instance_config (google.cloud.notebooks_v1.types.Instance.ShieldedInstanceConfig):
162-
Optional. Shielded VM configuration. [Images using supported
163-
Shielded VM features]
164-
(https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
161+
Optional. Shielded VM configuration. `Images using supported
162+
Shielded VM
163+
features <https://cloud.google.com/compute/docs/instances/modifying-shielded-vm>`__.
165164
no_public_ip (bool):
166165
If true, no public IP will be assigned to
167166
this instance.

‎google/cloud/notebooks_v1/types/instance_config.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ class InstanceConfig(proto.Message):
3030
format <https://en.wikipedia.org/wiki/Cron>`__.
3131
enable_health_monitoring (bool):
3232
Verifies core internal services are running.
33-
More info: go/notebooks-health
3433
"""
3534

3635
notebook_upgrade_schedule = proto.Field(proto.STRING, number=1,)

‎google/cloud/notebooks_v1/types/runtime.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -384,10 +384,9 @@ class RuntimeSoftwareConfig(proto.Message):
384384
GPU driver is stored. If not specified, we'll
385385
automatically choose from official GPU drivers.
386386
post_startup_script (str):
387-
Path to a Bash script that automatically runs
388-
after a notebook instance fully boots up. The
389-
path must be a URL or Cloud Storage path
390-
(gs://path-to-file/file-name).
387+
Path to a Bash script that automatically runs after a
388+
notebook instance fully boots up. The path must be a URL or
389+
Cloud Storage path (``gs://path-to-file/file-name``).
391390
"""
392391

393392
notebook_upgrade_schedule = proto.Field(proto.STRING, number=1,)

‎google/cloud/notebooks_v1/types/service.py‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -589,9 +589,12 @@ class ListSchedulesResponse(proto.Message):
589589
listing from the last result in the next list
590590
call.
591591
unreachable (Sequence[str]):
592-
Schedules that could not be reached. For example,
593-
['projects/{project_id}/location/{location}/schedules/monthly_digest',
594-
'projects/{project_id}/location/{location}/schedules/weekly_sentiment'].
592+
Schedules that could not be reached. For example:
593+
594+
::
595+
596+
['projects/{project_id}/location/{location}/schedules/monthly_digest',
597+
'projects/{project_id}/location/{location}/schedules/weekly_sentiment']
595598
"""
596599

597600
@property
@@ -670,7 +673,7 @@ class ListExecutionsRequest(proto.Message):
670673
filter (str):
671674
Filter applied to resulting executions. Currently only
672675
supports filtering executions by a specified schedule_id.
673-
Format: "schedule_id=<Schedule_ID>".
676+
Format: ``schedule_id=<Schedule_ID>``
674677
order_by (str):
675678
Sort by field.
676679
"""
@@ -692,9 +695,12 @@ class ListExecutionsResponse(proto.Message):
692695
listing from the last result in the next list
693696
call.
694697
unreachable (Sequence[str]):
695-
Executions IDs that could not be reached. For example,
696-
['projects/{project_id}/location/{location}/executions/imagenet_test1',
697-
'projects/{project_id}/location/{location}/executions/classifier_train1'].
698+
Executions IDs that could not be reached. For example:
699+
700+
::
701+
702+
['projects/{project_id}/location/{location}/executions/imagenet_test1',
703+
'projects/{project_id}/location/{location}/executions/classifier_train1']
698704
"""
699705

700706
@property

0 commit comments

Comments
 (0)