From 2b48de2ce1c3f8776c4ace587866d431dd5d1d02 Mon Sep 17 00:00:00 2001
From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com>
Date: Tue, 6 Dec 2022 15:13:09 -0500
Subject: [PATCH] docs: [notebooks] fix minor docstring formatting (#8846)

---
 .../cloud/notebooks/v1/DiagnosticConfig.java  | 140 ++++++++++--------
 .../v1/DiagnosticConfigOrBuilder.java         |  40 ++---
 .../notebooks/v1/diagnostic_config.proto      |  23 +--
 3 files changed, 112 insertions(+), 91 deletions(-)

diff --git a/java-notebooks/proto-google-cloud-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/DiagnosticConfig.java b/java-notebooks/proto-google-cloud-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/DiagnosticConfig.java
index 2b22fdda9fd2..ce3be0fc5e90 100644
--- a/java-notebooks/proto-google-cloud-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/DiagnosticConfig.java
+++ b/java-notebooks/proto-google-cloud-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/DiagnosticConfig.java
@@ -74,17 +74,17 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
    *
    *
    * <pre>
-   * Required. User Cloud Storage bucket location (REQUIRED)
-   * ## Must be formatted with path prefix (gs://$GCS_BUCKET)
+   * Required. User Cloud Storage bucket location (REQUIRED).
+   * Must be formatted with path prefix (`gs://$GCS_BUCKET`).
    * Permissions:
    * User Managed Notebooks:
    * - storage.buckets.writer: Must be given to the project's service account
-   * attached to VM.
+   *   attached to VM.
    * Google Managed Notebooks:
    * - storage.buckets.writer: Must be given to the project's service account or
-   * ## user credentials attached to VM depending on authentication mode.
+   *   user credentials attached to VM depending on authentication mode.
    * Cloud Storage bucket Log file will be written to
-   * gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
+   * `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
    * </pre>
    *
    * <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -107,17 +107,17 @@ public java.lang.String getGcsBucket() {
    *
    *
    * <pre>
-   * Required. User Cloud Storage bucket location (REQUIRED)
-   * ## Must be formatted with path prefix (gs://$GCS_BUCKET)
+   * Required. User Cloud Storage bucket location (REQUIRED).
+   * Must be formatted with path prefix (`gs://$GCS_BUCKET`).
    * Permissions:
    * User Managed Notebooks:
    * - storage.buckets.writer: Must be given to the project's service account
-   * attached to VM.
+   *   attached to VM.
    * Google Managed Notebooks:
    * - storage.buckets.writer: Must be given to the project's service account or
-   * ## user credentials attached to VM depending on authentication mode.
+   *   user credentials attached to VM depending on authentication mode.
    * Cloud Storage bucket Log file will be written to
-   * gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
+   * `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
    * </pre>
    *
    * <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -143,10 +143,12 @@ public com.google.protobuf.ByteString getGcsBucketBytes() {
    *
    *
    * <pre>
-   * Optional. Defines the relative storage path in the Cloud Storage bucket where the
-   * diagnostic logs will be written: Default path will be the root directory of
-   * the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
-   * full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
+   * Optional. Defines the relative storage path in the Cloud Storage bucket
+   * where the diagnostic logs will be written: Default path will be the root
+   * directory of the Cloud Storage bucket
+   * (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
+   * Example of full path where Log file will be written:
+   * `gs://$GCS_BUCKET/$RELATIVE_PATH/`
    * </pre>
    *
    * <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -169,10 +171,12 @@ public java.lang.String getRelativePath() {
    *
    *
    * <pre>
-   * Optional. Defines the relative storage path in the Cloud Storage bucket where the
-   * diagnostic logs will be written: Default path will be the root directory of
-   * the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
-   * full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
+   * Optional. Defines the relative storage path in the Cloud Storage bucket
+   * where the diagnostic logs will be written: Default path will be the root
+   * directory of the Cloud Storage bucket
+   * (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
+   * Example of full path where Log file will be written:
+   * `gs://$GCS_BUCKET/$RELATIVE_PATH/`
    * </pre>
    *
    * <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -665,17 +669,17 @@ public Builder mergeFrom(
      *
      *
      * <pre>
-     * Required. User Cloud Storage bucket location (REQUIRED)
-     * ## Must be formatted with path prefix (gs://$GCS_BUCKET)
+     * Required. User Cloud Storage bucket location (REQUIRED).
+     * Must be formatted with path prefix (`gs://$GCS_BUCKET`).
      * Permissions:
      * User Managed Notebooks:
      * - storage.buckets.writer: Must be given to the project's service account
-     * attached to VM.
+     *   attached to VM.
      * Google Managed Notebooks:
      * - storage.buckets.writer: Must be given to the project's service account or
-     * ## user credentials attached to VM depending on authentication mode.
+     *   user credentials attached to VM depending on authentication mode.
      * Cloud Storage bucket Log file will be written to
-     * gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
+     * `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
      * </pre>
      *
      * <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -697,17 +701,17 @@ public java.lang.String getGcsBucket() {
      *
      *
      * <pre>
-     * Required. User Cloud Storage bucket location (REQUIRED)
-     * ## Must be formatted with path prefix (gs://$GCS_BUCKET)
+     * Required. User Cloud Storage bucket location (REQUIRED).
+     * Must be formatted with path prefix (`gs://$GCS_BUCKET`).
      * Permissions:
      * User Managed Notebooks:
      * - storage.buckets.writer: Must be given to the project's service account
-     * attached to VM.
+     *   attached to VM.
      * Google Managed Notebooks:
      * - storage.buckets.writer: Must be given to the project's service account or
-     * ## user credentials attached to VM depending on authentication mode.
+     *   user credentials attached to VM depending on authentication mode.
      * Cloud Storage bucket Log file will be written to
-     * gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
+     * `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
      * </pre>
      *
      * <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -729,17 +733,17 @@ public com.google.protobuf.ByteString getGcsBucketBytes() {
      *
      *
      * <pre>
-     * Required. User Cloud Storage bucket location (REQUIRED)
-     * ## Must be formatted with path prefix (gs://$GCS_BUCKET)
+     * Required. User Cloud Storage bucket location (REQUIRED).
+     * Must be formatted with path prefix (`gs://$GCS_BUCKET`).
      * Permissions:
      * User Managed Notebooks:
      * - storage.buckets.writer: Must be given to the project's service account
-     * attached to VM.
+     *   attached to VM.
      * Google Managed Notebooks:
      * - storage.buckets.writer: Must be given to the project's service account or
-     * ## user credentials attached to VM depending on authentication mode.
+     *   user credentials attached to VM depending on authentication mode.
      * Cloud Storage bucket Log file will be written to
-     * gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
+     * `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
      * </pre>
      *
      * <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -760,17 +764,17 @@ public Builder setGcsBucket(java.lang.String value) {
      *
      *
      * <pre>
-     * Required. User Cloud Storage bucket location (REQUIRED)
-     * ## Must be formatted with path prefix (gs://$GCS_BUCKET)
+     * Required. User Cloud Storage bucket location (REQUIRED).
+     * Must be formatted with path prefix (`gs://$GCS_BUCKET`).
      * Permissions:
      * User Managed Notebooks:
      * - storage.buckets.writer: Must be given to the project's service account
-     * attached to VM.
+     *   attached to VM.
      * Google Managed Notebooks:
      * - storage.buckets.writer: Must be given to the project's service account or
-     * ## user credentials attached to VM depending on authentication mode.
+     *   user credentials attached to VM depending on authentication mode.
      * Cloud Storage bucket Log file will be written to
-     * gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
+     * `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
      * </pre>
      *
      * <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -787,17 +791,17 @@ public Builder clearGcsBucket() {
      *
      *
      * <pre>
-     * Required. User Cloud Storage bucket location (REQUIRED)
-     * ## Must be formatted with path prefix (gs://$GCS_BUCKET)
+     * Required. User Cloud Storage bucket location (REQUIRED).
+     * Must be formatted with path prefix (`gs://$GCS_BUCKET`).
      * Permissions:
      * User Managed Notebooks:
      * - storage.buckets.writer: Must be given to the project's service account
-     * attached to VM.
+     *   attached to VM.
      * Google Managed Notebooks:
      * - storage.buckets.writer: Must be given to the project's service account or
-     * ## user credentials attached to VM depending on authentication mode.
+     *   user credentials attached to VM depending on authentication mode.
      * Cloud Storage bucket Log file will be written to
-     * gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
+     * `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
      * </pre>
      *
      * <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -821,10 +825,12 @@ public Builder setGcsBucketBytes(com.google.protobuf.ByteString value) {
      *
      *
      * <pre>
-     * Optional. Defines the relative storage path in the Cloud Storage bucket where the
-     * diagnostic logs will be written: Default path will be the root directory of
-     * the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
-     * full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
+     * Optional. Defines the relative storage path in the Cloud Storage bucket
+     * where the diagnostic logs will be written: Default path will be the root
+     * directory of the Cloud Storage bucket
+     * (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
+     * Example of full path where Log file will be written:
+     * `gs://$GCS_BUCKET/$RELATIVE_PATH/`
      * </pre>
      *
      * <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -846,10 +852,12 @@ public java.lang.String getRelativePath() {
      *
      *
      * <pre>
-     * Optional. Defines the relative storage path in the Cloud Storage bucket where the
-     * diagnostic logs will be written: Default path will be the root directory of
-     * the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
-     * full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
+     * Optional. Defines the relative storage path in the Cloud Storage bucket
+     * where the diagnostic logs will be written: Default path will be the root
+     * directory of the Cloud Storage bucket
+     * (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
+     * Example of full path where Log file will be written:
+     * `gs://$GCS_BUCKET/$RELATIVE_PATH/`
      * </pre>
      *
      * <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -871,10 +879,12 @@ public com.google.protobuf.ByteString getRelativePathBytes() {
      *
      *
      * <pre>
-     * Optional. Defines the relative storage path in the Cloud Storage bucket where the
-     * diagnostic logs will be written: Default path will be the root directory of
-     * the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
-     * full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
+     * Optional. Defines the relative storage path in the Cloud Storage bucket
+     * where the diagnostic logs will be written: Default path will be the root
+     * directory of the Cloud Storage bucket
+     * (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
+     * Example of full path where Log file will be written:
+     * `gs://$GCS_BUCKET/$RELATIVE_PATH/`
      * </pre>
      *
      * <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -895,10 +905,12 @@ public Builder setRelativePath(java.lang.String value) {
      *
      *
      * <pre>
-     * Optional. Defines the relative storage path in the Cloud Storage bucket where the
-     * diagnostic logs will be written: Default path will be the root directory of
-     * the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
-     * full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
+     * Optional. Defines the relative storage path in the Cloud Storage bucket
+     * where the diagnostic logs will be written: Default path will be the root
+     * directory of the Cloud Storage bucket
+     * (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
+     * Example of full path where Log file will be written:
+     * `gs://$GCS_BUCKET/$RELATIVE_PATH/`
      * </pre>
      *
      * <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -915,10 +927,12 @@ public Builder clearRelativePath() {
      *
      *
      * <pre>
-     * Optional. Defines the relative storage path in the Cloud Storage bucket where the
-     * diagnostic logs will be written: Default path will be the root directory of
-     * the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
-     * full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
+     * Optional. Defines the relative storage path in the Cloud Storage bucket
+     * where the diagnostic logs will be written: Default path will be the root
+     * directory of the Cloud Storage bucket
+     * (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
+     * Example of full path where Log file will be written:
+     * `gs://$GCS_BUCKET/$RELATIVE_PATH/`
      * </pre>
      *
      * <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
diff --git a/java-notebooks/proto-google-cloud-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/DiagnosticConfigOrBuilder.java b/java-notebooks/proto-google-cloud-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/DiagnosticConfigOrBuilder.java
index 900fec64cd7c..39dcc244d81b 100644
--- a/java-notebooks/proto-google-cloud-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/DiagnosticConfigOrBuilder.java
+++ b/java-notebooks/proto-google-cloud-notebooks-v1/src/main/java/com/google/cloud/notebooks/v1/DiagnosticConfigOrBuilder.java
@@ -27,17 +27,17 @@ public interface DiagnosticConfigOrBuilder
    *
    *
    * <pre>
-   * Required. User Cloud Storage bucket location (REQUIRED)
-   * ## Must be formatted with path prefix (gs://$GCS_BUCKET)
+   * Required. User Cloud Storage bucket location (REQUIRED).
+   * Must be formatted with path prefix (`gs://$GCS_BUCKET`).
    * Permissions:
    * User Managed Notebooks:
    * - storage.buckets.writer: Must be given to the project's service account
-   * attached to VM.
+   *   attached to VM.
    * Google Managed Notebooks:
    * - storage.buckets.writer: Must be given to the project's service account or
-   * ## user credentials attached to VM depending on authentication mode.
+   *   user credentials attached to VM depending on authentication mode.
    * Cloud Storage bucket Log file will be written to
-   * gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
+   * `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
    * </pre>
    *
    * <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -49,17 +49,17 @@ public interface DiagnosticConfigOrBuilder
    *
    *
    * <pre>
-   * Required. User Cloud Storage bucket location (REQUIRED)
-   * ## Must be formatted with path prefix (gs://$GCS_BUCKET)
+   * Required. User Cloud Storage bucket location (REQUIRED).
+   * Must be formatted with path prefix (`gs://$GCS_BUCKET`).
    * Permissions:
    * User Managed Notebooks:
    * - storage.buckets.writer: Must be given to the project's service account
-   * attached to VM.
+   *   attached to VM.
    * Google Managed Notebooks:
    * - storage.buckets.writer: Must be given to the project's service account or
-   * ## user credentials attached to VM depending on authentication mode.
+   *   user credentials attached to VM depending on authentication mode.
    * Cloud Storage bucket Log file will be written to
-   * gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
+   * `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
    * </pre>
    *
    * <code>string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -72,10 +72,12 @@ public interface DiagnosticConfigOrBuilder
    *
    *
    * <pre>
-   * Optional. Defines the relative storage path in the Cloud Storage bucket where the
-   * diagnostic logs will be written: Default path will be the root directory of
-   * the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
-   * full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
+   * Optional. Defines the relative storage path in the Cloud Storage bucket
+   * where the diagnostic logs will be written: Default path will be the root
+   * directory of the Cloud Storage bucket
+   * (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
+   * Example of full path where Log file will be written:
+   * `gs://$GCS_BUCKET/$RELATIVE_PATH/`
    * </pre>
    *
    * <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -87,10 +89,12 @@ public interface DiagnosticConfigOrBuilder
    *
    *
    * <pre>
-   * Optional. Defines the relative storage path in the Cloud Storage bucket where the
-   * diagnostic logs will be written: Default path will be the root directory of
-   * the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
-   * full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
+   * Optional. Defines the relative storage path in the Cloud Storage bucket
+   * where the diagnostic logs will be written: Default path will be the root
+   * directory of the Cloud Storage bucket
+   * (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
+   * Example of full path where Log file will be written:
+   * `gs://$GCS_BUCKET/$RELATIVE_PATH/`
    * </pre>
    *
    * <code>string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
diff --git a/java-notebooks/proto-google-cloud-notebooks-v1/src/main/proto/google/cloud/notebooks/v1/diagnostic_config.proto b/java-notebooks/proto-google-cloud-notebooks-v1/src/main/proto/google/cloud/notebooks/v1/diagnostic_config.proto
index 5dad7ae18438..dcde42557c79 100644
--- a/java-notebooks/proto-google-cloud-notebooks-v1/src/main/proto/google/cloud/notebooks/v1/diagnostic_config.proto
+++ b/java-notebooks/proto-google-cloud-notebooks-v1/src/main/proto/google/cloud/notebooks/v1/diagnostic_config.proto
@@ -25,25 +25,27 @@ option java_package = "com.google.cloud.notebooks.v1";
 
 // Defines flags that are used to run the diagnostic tool
 message DiagnosticConfig {
-  // Required. User Cloud Storage bucket location (REQUIRED)
-  // ## Must be formatted with path prefix (gs://$GCS_BUCKET)
+  // Required. User Cloud Storage bucket location (REQUIRED).
+  // Must be formatted with path prefix (`gs://$GCS_BUCKET`).
   //
   // Permissions:
   // User Managed Notebooks:
   // - storage.buckets.writer: Must be given to the project's service account
-  // attached to VM.
+  //   attached to VM.
   // Google Managed Notebooks:
   // - storage.buckets.writer: Must be given to the project's service account or
-  // ## user credentials attached to VM depending on authentication mode.
+  //   user credentials attached to VM depending on authentication mode.
   //
   // Cloud Storage bucket Log file will be written to
-  // gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
+  // `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
   string gcs_bucket = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // Optional. Defines the relative storage path in the Cloud Storage bucket where the
-  // diagnostic logs will be written: Default path will be the root directory of
-  // the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of
-  // full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
+  // Optional. Defines the relative storage path in the Cloud Storage bucket
+  // where the diagnostic logs will be written: Default path will be the root
+  // directory of the Cloud Storage bucket
+  // (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
+  // Example of full path where Log file will be written:
+  // `gs://$GCS_BUCKET/$RELATIVE_PATH/`
   string relative_path = 2 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Enables flag to repair service for instance
@@ -53,5 +55,6 @@ message DiagnosticConfig {
   bool packet_capture_flag_enabled = 4 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Enables flag to copy all `/home/jupyter` folder contents
-  bool copy_home_files_flag_enabled = 5 [(google.api.field_behavior) = OPTIONAL];
+  bool copy_home_files_flag_enabled = 5
+      [(google.api.field_behavior) = OPTIONAL];
 }