Document show_error_codes config option and CLI flag#20767
Open
veeceey wants to merge 1 commit intopython:masterfrom
Open
Document show_error_codes config option and CLI flag#20767veeceey wants to merge 1 commit intopython:masterfrom
veeceey wants to merge 1 commit intopython:masterfrom
Conversation
Fixes python#17083 Both the config file and command line documentation were missing documentation for show_error_codes, which is the default behavior (error codes are shown by default). Added documentation for: - show_error_codes in config_file.rst (as the default True option) - --show-error-codes in command_line.rst (as the default behavior) This makes it clear that error codes are shown by default and that users can use either show_error_codes=True or hide_error_codes=False in the config file, and either --show-error-codes or --no-hide-error-codes on the command line.
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.
Summary
Fixes #17083
Both the config file and command line documentation were missing documentation for
show_error_codes, which is the default behavior (error codes are shown by default).Changes
show_error_codesdocumentation inconfig_file.rst(as the default True option)--show-error-codesdocumentation incommand_line.rst(as the default behavior)This makes it clear that:
show_error_codes = Trueorhide_error_codes = Falsein the config file--show-error-codesor--no-hide-error-codeson the command lineTest plan