Add guidance on explaining commands and variables #541
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.
Guidance for explaining a command or elements in a code block
Issue:
#540
Additional information:
TLDR: Stop using callouts in code blocks, use simple sentences, bulleted/unordered lists, Distribution lists or Note style as appropriate. This needs to be done before we migrate to the new tool.
Problem statement:
Current usage and recommended changes:
-- Current usage: Callouts
-- Suggested change:
--- Use a simple sentence.
-- Current usage: Callouts
-- Suggested change:
--- Use a bulleted list
---- List the explanations in the order in which they appear in the code block.
-- Current usage: Callouts
--Suggested change:
--- Use a definition list
---- List the parameters/variables in the order in which they appear in the code block.
---- Introduce definition lists with "where:" and begin each variable description with "Specifies.”
-- Current usage: Callouts
-- Suggested change:
--- Use the appropriate admonition style to add notes pertaining to a code block