-
Notifications
You must be signed in to change notification settings - Fork 127
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 a reference for available config keys in help & docs #1910
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
Gedochao
added
documentation
Improvements or additions to documentation
help
All the issues related to improving help outputs
labels
Mar 7, 2023
Gedochao
force-pushed
the
config-keys-reference
branch
3 times, most recently
from
March 7, 2023 11:54
0546366
to
2dd762e
Compare
Gedochao
changed the title
Add a reference for available config keys in help & reference docs
Add a reference for available config keys in help & docs
Mar 7, 2023
Gedochao
force-pushed
the
config-keys-reference
branch
from
March 7, 2023 12:17
10b6a4d
to
2201bb7
Compare
Gedochao
requested review from
lwronski,
MaciejG604,
tgodzik and
alexarchambault
March 7, 2023 12:41
lwronski
reviewed
Mar 7, 2023
modules/cli/src/main/scala/scala/cli/commands/config/ConfigOptions.scala
Show resolved
Hide resolved
Gedochao
force-pushed
the
config-keys-reference
branch
from
March 8, 2023 08:10
2201bb7
to
aee77c3
Compare
…losing if no fence was open
…e consistent with `case-app` options' help
…`, while only showing others in `--full-help`
- it's not a `power` command, fixed it not to be tagged as such - moved the doc to the core commands level, as it is now useful to the average user - added a reference to the available config keys in the doc - extra examples, misc fixes
Gedochao
force-pushed
the
config-keys-reference
branch
from
March 8, 2023 08:11
aee77c3
to
e52f002
Compare
lwronski
approved these changes
Mar 8, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
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
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.
Fixes #1623
These changes add the available config keys to the
config
sub-command's--help
and--full-help
output (and thus, to the reference docs).Only non-hidden (important for the average user) keys are listed in the short
--help
.I also tweaked the
config
sub-command doc:commands
website levelShort
config
help output:Full
config
help output: