Docs: Change parameter delimiter to parentheses #1068
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
osg-grafana
changed the title
pracucci
approved these changes
Feb 8, 2022
osg-grafana
approved these changes
Feb 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In https://github.com/grafana/mimir/blob/main/docs/sources/configuration/config-file-reference.template, we state that square brackets are used in the YAML reference of configuration parameters to denote an optional parameter. So, using square brackets to delimit the parameter category of advanced or experimental would overload the use of square brackets.
This PR changes the square brackets to parentheses. No information is lost. It is just formatted differently.