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

Format for documenting variables and placeholders? #262

@tang-mm

Description

@tang-mm

Suggestions from the Google style guide:

  • wrapping placeholders in a element and use uppercase characters with underscore delimiters, such as PROJECT_ID
  • In Markdown, wrap inline placeholders in backticks (), and use an asterisk (*) before the first backtick and after the second one (*PLACEHOLDER_NAME`*).
  • If the context in which your placeholders appear makes using uppercase characters with underscore delimiters a bad idea, use something else that makes sense to you, but be internally consistent.

However, in our templates, curly braces { } have been commonly used. We should have a set of guidelines regarding the format.

See the related review comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    style questionQuestions for the style guide

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions