github.com/googleapis/api-linter@v1.65.2/docs/rules/0192/trademarked-names.md (about)

     1  ---
     2  rule:
     3    aip: 192
     4    name: [core, '0192', trademarked-names]
     5    summary: Trademarked names should be used correctly.
     6  permalink: /192/trademarked-names
     7  redirect_from:
     8    - /0192/trademarked-names
     9  ---
    10  
    11  # Trademarked names
    12  
    13  This rule enforces trademarked names in public comments are not abbreviated and
    14  follow the trademark owner's branding style, 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 it catches a common trademark mistake. It only
    20  checks against a known problem list, and does not make guesses beyond that.
    21  
    22  It currently catches common mistaken variants for:
    23  
    24  - App Engine
    25  - BigQuery
    26  - Bigtable
    27  - Bitbucket
    28  - Cloud Storage
    29  - Compute Engine
    30  - Dataflow
    31  - Dataprep
    32  - Dialogflow
    33  - Directory Sync
    34  - GitHub
    35  - GitLab
    36  - G Suite
    37  - Pub/Sub
    38  - Service Mesh
    39  - Stack Overflow
    40  
    41  ## Examples
    42  
    43  **Incorrect** code for this rule:
    44  
    45  ```proto
    46  // Incorrect.
    47  message Book {
    48    string name = 1;
    49  
    50    // A repository containing Markdown files for each chapter of
    51    // the book on Github.
    52    // (--           ^ Should be GitHub. --)
    53    string github_repo = 2;
    54  }
    55  ```
    56  
    57  **Correct** code for this rule:
    58  
    59  ```proto
    60  // Correct.
    61  message Book {
    62    string name = 1;
    63  
    64    // A repository containing Markdown files for each chapter of
    65    // the book on GitHub.
    66    string github_repo = 2;
    67  }
    68  ```
    69  
    70  ## Disabling
    71  
    72  If you need to violate this rule, use a leading comment above the descriptor.
    73  Remember to also include an [aip.dev/not-precedent][] comment explaining why.
    74  
    75  ```proto
    76  message Book {
    77    string name = 1;
    78  
    79    // (-- api-linter: core::0192::trademarked-names=disabled
    80    //     aip.dev/not-precedent: We need to do this because reasons. --)
    81    // A repository containing Markdown files for each chapter of
    82    // the book on Github.
    83    string github_repo = 2;
    84  }
    85  ```
    86  
    87  [aip-192]: https://aip.dev/192
    88  [aip.dev/not-precedent]: https://aip.dev/not-precedent