github.com/googleapis/api-linter@v1.65.2/docs/rules/0192/no-markdown-tables.md (about)

     1  ---
     2  rule:
     3    aip: 192
     4    name: [core, '0192', no-markdown-tables]
     5    summary: Public comments should not include Markdown tables.
     6  permalink: /192/no-markdown-tables
     7  redirect_from:
     8    - /0192/no-markdown-tables
     9  ---
    10  
    11  # No Markdown tables
    12  
    13  This rule enforces that public comments for proto descriptors do not have
    14  Markdown tables, as mandated in [AIP-192][].
    15  
    16  ## Details
    17  
    18  This rule looks at each descriptor in each proto file (exempting oneofs and the
    19  file itself) and complains if _public_ comments include Markdown tables.
    20  
    21  ## Examples
    22  
    23  **Incorrect** code for this rule:
    24  
    25  ```proto
    26  // Incorrect.
    27  // Fields on the book include:
    28  //
    29  // Name     | Type
    30  // -------- | --------
    31  // `name`   | `string`
    32  // `author` | `string`
    33  message Book {
    34    // The resource name of the book.
    35    string name = 1;
    36  }
    37  ```
    38  
    39  **Correct** code for this rule:
    40  
    41  ```proto
    42  // Correct.
    43  // Fields on the book include:
    44  //
    45  // - `name`: `string`
    46  // - `author`: `string`
    47  message Book {
    48    // The resource name of the book.
    49    string name = 1;
    50  }
    51  ```
    52  
    53  ## Disabling
    54  
    55  If you need to violate this rule, use a leading comment above the descriptor.
    56  Remember to also include an [aip.dev/not-precedent][] comment explaining why.
    57  
    58  ```proto
    59  // Fields on the book include:
    60  //
    61  // Name     | Type
    62  // -------- | --------
    63  // `name`   | `string`
    64  // `author` | `string`
    65  // (-- api-linter: core::0192::no-markdown-tables=disabled
    66  //     aip.dev/not-precedent: We need to do this because reasons. --)
    67  message Book {
    68    // The resource name of the book.
    69    string name = 1;
    70  }
    71  ```
    72  
    73  [aip-192]: https://aip.dev/192
    74  [aip.dev/not-precedent]: https://aip.dev/not-precedent