Ensure no console-syntax in reference docs and no md fenced blocks in --help
#1874
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
Gedochao
force-pushed
the
adjust-reference-docs
branch
from
6109953
to
1d83693
Compare
Gedochao
force-pushed
the
adjust-reference-docs
branch
from
1d83693
to
580bece
Compare
Gedochao
added
documentation
Gedochao
force-pushed
the
adjust-reference-docs
branch
from
580bece
to
67b7d92
Compare
Gedochao
changed the title
md fenced blocks in --help
tgodzik
approved these changes
Feb 24, 2023
modules/generate-reference-doc/src/main/scala/scala/cli/doc/ReferenceDocUtils.scala
Outdated
Show resolved
Hide resolved
lwronski
approved these changes
Feb 27, 2023
modules/generate-reference-doc/src/main/scala/scala/cli/doc/ReferenceDocUtils.scala
Outdated
Show resolved
Hide resolved
- use `detailedMessage` instead of `message` for commands, where defined - convert console keys to markdown fence code blocks - filter out console keys from reference docs
Gedochao
force-pushed
the
adjust-reference-docs
branch
from
67b7d92
to
b39076b
Compare
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.
A follow-up for #1872 (comment)
Depends on #1872Tweaks:
Console.BOLD,Console.RESETetc.) don't go into the reference doc (as they're then not encoded properly)--full-helpdetailed messages are included in the reference docs where applicable (HelpMessage.detailedMessage)