You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
--warn-unused-configs option is described in the beginning of the documentation in Config file section, but warn_unused_configs option is described in the end of the documentation in Miscellaneous section.
(WONTFIX)
in Import discovery section the order of listing options is different.
(FIXED)
--no-site-packages option is described in command line documentation, but is not mentioned in config file documentation and is not really working in config file.
(WONTFIX until Expose --no-site-packages to configuration file. #7768 is resolved)
In Platform configuration section the order of listing options is different.
(FIXED)
--warn-redundant-casts option is listed under Configuring warnings section in command line documentation, but under Miscellaneous section in config file documentation.
(FIXED)
--allow-untyped-globals options is not mentioned in config file documentation.
(FIXED)
--strict-optional-whitelist, --pretty, --sqlite-cache, --cache-fine-grained, --skip-cache-mtime-checks, --raise-exceptions, options are not mentioned in config file documentation.
(FIXED)
--lineprecision-report, --memory-xml-report, --xml-report options are not mentioned in neither config file documentation nor command line documentation.
(FIXED, requires followup after Some Report generation options are undocumented #7775 is resolved)
no_implicit_optional and no_silence_site_packages options should probably be documented without no_. Also, options without no_ are not actually working, while they probably should.
(WONTFIX until Some command line / config file options are not reversable #7773 is resolved)
new_semantic_analyzer option should probably be removed from the config file documentation.
(FIXED)
The text was updated successfully, but these errors were encountered:
jolaf
changed the title
Command line options are described in a different order than similar options in config file
Config file options are described in a different order than similar command line options
Sep 27, 2019
This pull request reorganizes the command line docs, the config file docs, and
the output of `--help` so they all list the options in the same order and all
use the same section heading titles.
It also adds a few previously undocumented flags to the docs, such as `--pretty`
and several of the report generation flags.
As a part of this cleanup, this PR also makes two minor changes to the flags
themselves: `--custom-typing` was renamed to `--custom-typing-module` and
the `--strict-optional-whitelist` flag was deprecated.
Fixes#7574, #7575, #7772.
mypy 0.740
The order in which the command line options are documented at
https://mypy.readthedocs.io/en/latest/command_line.html
is different from the order the similarly named options are documented at
https://mypy.readthedocs.io/en/latest/config_file.html.
This inconsistency could be confusing.
In particular:
--warn-unused-configs
option is described in the beginning of the documentation inConfig file
section, butwarn_unused_configs
option is described in the end of the documentation inMiscellaneous
section.(WONTFIX)
in
Import discovery
section the order of listing options is different.(FIXED)
--no-site-packages
option is described in command line documentation, but is not mentioned in config file documentation and is not really working in config file.(WONTFIX until Expose
--no-site-packages
to configuration file. #7768 is resolved)In
Platform configuration
section the order of listing options is different.(FIXED)
--warn-redundant-casts
option is listed underConfiguring warnings
section in command line documentation, but underMiscellaneous
section in config file documentation.(FIXED)
--allow-untyped-globals
options is not mentioned in config file documentation.(FIXED)
--strict-optional-whitelist
,--pretty
,--sqlite-cache
,--cache-fine-grained
,--skip-cache-mtime-checks
,--raise-exceptions
, options are not mentioned in config file documentation.(FIXED)
--lineprecision-report
,--memory-xml-report
,--xml-report
options are not mentioned in neither config file documentation nor command line documentation.(FIXED, requires followup after Some Report generation options are undocumented #7775 is resolved)
--custom-typing
option is namedcustom_typing_module
in config file documentation.(WONTFIX until --custom-typing command line option is named custom_typing_module in config file #7772 is resolved)
Report generation
section options are missing from config file documentation.(FIXED)
follow_imports_for_stubs
,show_none_errors
,ignore_errors
options are not mentioned in neither command line documentation nor in--help
.(WONTFIX until Command line options for suppressing errors are not available #7774 is resolved)
no_implicit_optional
andno_silence_site_packages
options should probably be documented withoutno_
. Also, options withoutno_
are not actually working, while they probably should.(WONTFIX until Some command line / config file options are not reversable #7773 is resolved)
new_semantic_analyzer
option should probably be removed from the config file documentation.(FIXED)
The text was updated successfully, but these errors were encountered: