Skip to content
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

Config file options are described in a different order than similar command line options #7575

Closed
jolaf opened this issue Sep 27, 2019 · 3 comments

Comments

@jolaf
Copy link
Contributor

jolaf commented Sep 27, 2019

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 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)

  • --custom-typing option is named custom_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 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)

@jolaf 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
@ilevkivskyi
Copy link
Member

As in #7574: this doesn't look urgent, it would make sense to keep these more in sync.

@jolaf
Copy link
Contributor Author

jolaf commented Oct 21, 2019

Now working on PR for this.
Would take some time as there's a lot of inconsistencies.

@jolaf
Copy link
Contributor Author

jolaf commented Oct 22, 2019

Also this suggestion is implemented here:
#7574 (comment)

Michael0x2a pushed a commit that referenced this issue Oct 23, 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants