[GH#535]: Remove asterisk formatting guidance for commands #543
Conversation
This file contains hidden or 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
Asterisks around commands break commands that already contain one or more asterisk wilcards. Fixes #535
|
When merging, please choose the option to squash commits. Thanks. |
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.
This PR removes the requirement to enclose commands in asterisks for bold formatting. This formatting breaks commands that contain wildcard characters (
*), making them non-functional when copied and pasted.Issue: #535
Impact: This bug must be fixed before the organization implements the new guidance for separating commands from output, as it would otherwise affect a significant number of command examples.
Next steps: The organization should determine whether bold formatting for commands remains necessary now that commands are visually separated from output. If bold formatting is still desired, we should evaluate alternative implementation methods (such as CSS) that won't interfere with command syntax.
@IngridT1