docs: add loglevel to install and update command documentation#8811
Closed
MaxBlack-dev wants to merge 1 commit into
Closed
docs: add loglevel to install and update command documentation#8811MaxBlack-dev wants to merge 1 commit into
MaxBlack-dev wants to merge 1 commit into
Conversation
Adds loglevel to the params array for install, update, and ci commands to make this option more discoverable in the help documentation.
MaxBlack-dev
force-pushed
the
docs/4690-add-loglevel-to-install-update
branch
from
e0a15a2 to
abc868a
Compare
Contributor
Author
|
Closing this PR as the tests are not passing. Will investigate the issue further before resubmitting. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This PR adds the loglevel configuration option to the documentation for
pm install and
pm update commands.
Changes
This makes the loglevel option visible in the generated documentation for both commands, allowing users to easily discover that they can use --loglevel=verbose or --loglevel=silly to see more detailed output during package installation and updates.
Fixes
Closes #4690
Context
As discussed in #4690, users often don't realize that --loglevel can be used with
pm install and
pm update to get more verbose output. While loglevel is a global option available for all commands, it's particularly useful for these two frequently-used commands where users want to see detailed progress information.
The maintainer @lukekarrys suggested this could be added to make it more discoverable, even though it's a global option, since these are very commonly used commands where verbose output is frequently desired.