Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

style guide: inconsistent representations of placeholder values #41

Open
tallclair opened this issue Sep 14, 2023 · 0 comments
Open

style guide: inconsistent representations of placeholder values #41

tallclair opened this issue Sep 14, 2023 · 0 comments

Comments

@tallclair
Copy link
Collaborator

We should try to be consistent with documentation style, which maybe warrants adding a style guide. For starters, I've noticed inconsistencies in how <placeholder> values are represented:

<placeholder>
PLACEHOLDER
%placeholder%
<compound placeholder>
<compound-placeholder>
<compound_placeholder>
$PLACEHOLDER

Angle brackets <placeholder> seems to be most widely used (recommended by the k8s docs style guide). Capitalization and spacing might be optional, but my personal preference is for upper case with underscores: <COMPOUND_PLACEHOLDER>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant