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
Add more detail for sub-commands' help messages #1852
Merged
Gedochao
merged 27 commits into
VirtusLab:main
from
Gedochao:new-subcommand-help-messages
Feb 15, 2023
Merged
Add more detail for sub-commands' help messages #1852
Gedochao
merged 27 commits into
VirtusLab:main
from
Gedochao:new-subcommand-help-messages
Feb 15, 2023
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
new-subcommand-help-messages
branch
2 times, most recently
from
February 13, 2023 09:17
6fb9768
to
873802e
Compare
Gedochao
added
documentation
Improvements or additions to documentation
SIP-46
All the issues related to SIP-46 to turn Scala CLI into the official scala runner command.
help
All the issues related to improving help outputs
labels
Feb 13, 2023
lwronski
reviewed
Feb 13, 2023
modules/cli/src/main/scala/scala/cli/commands/run/RunOptions.scala
Outdated
Show resolved
Hide resolved
modules/cli/src/main/scala/scala/cli/commands/version/VersionOptions.scala
Outdated
Show resolved
Hide resolved
modules/cli/src/main/scala/scala/cli/commands/test/TestOptions.scala
Outdated
Show resolved
Hide resolved
modules/cli/src/main/scala/scala/cli/commands/setupide/SetupIdeOptions.scala
Show resolved
Hide resolved
modules/cli/src/main/scala/scala/cli/commands/publish/PublishLocalOptions.scala
Show resolved
Hide resolved
modules/cli/src/main/scala/scala/cli/commands/package0/PackageOptions.scala
Show resolved
Hide resolved
…me` sub-commands
…bloop start` sub-commands
…re such a doc exists
Gedochao
force-pushed
the
new-subcommand-help-messages
branch
from
February 14, 2023 10:39
873802e
to
a0d8aae
Compare
lwronski
approved these changes
Feb 15, 2023
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
help
All the issues related to improving help outputs
SIP-46
All the issues related to SIP-46 to turn Scala CLI into the official scala runner command.
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.
Context: #1669
This is the first batch of help tweaks aiming at improving their usefulness.
It focuses on individual sub-commands' help messages (and not their options' help messages, which will be addressed separately).
Example for the
run
sub-command: