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

Format for documenting variables and placeholders? #262

Open
tang-mm opened this issue Jul 26, 2022 · 1 comment
Open

Format for documenting variables and placeholders? #262

tang-mm opened this issue Jul 26, 2022 · 1 comment
Labels
style question Questions for the style guide

Comments

@tang-mm
Copy link

tang-mm commented Jul 26, 2022

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

@barbaricyawps barbaricyawps added the style question Questions for the style guide label Jul 27, 2022
@heykayla
Copy link

Agreed to continue using curly brackets for both placeholder text and writer's notes.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
style question Questions for the style guide
Projects
None yet
Development

No branches or pull requests

3 participants