Skip to content

Command line documentation differs from --help #7574

Description

@jolaf

mypy 0.740

The order in which the command line options are described is different in --help output and in the documentation at https://mypy.readthedocs.io/en/latest/command_line.html, and section names also differ. This inconsistency could be confusing.

Particularly:

  • In Import discovery section, --named-packages option goes first in the documentation, but last in --help.
    (FIXED)

  • Disallow dynamic typing section in the documentation is named Dynamic typing in --help.
    (FIXED)

  • In Disallow dynamic typing section, --disallow-subclassing-any option goes last in the documentation, but second in --help.
    (FIXED)

  • --strict-optional-whitelist option is not mentioned in the documentation.
    (FIXED)

  • Configuring warnings section in the documentation is named Warnings in --help.
    (FIXED)

  • Miscellaneous strictness flags section in the documentation is named Other strictness checks in --help.
    (FIXED)

  • In Miscellaneous strictness flags section, --strict-equality option goes after --no-implicit-reexport option in the documentation, but before it in --help.
    (FIXED)

  • Configuring error messages goes after Miscellaneous strictness flags section in the documentation, but after Mypy internals in --help.
    (FIXED)

  • Configuring error messages in the documentation is named Error reporting in --help.
    (FIXED)

  • --pretty option is not mentioned in the documentation.
    (FIXED)

  • --sqlite-cache, --cache-fine-grained, --skip-cache-mtime-checks are not mentioned in the documentation.
    (FIXED)

  • Advanced flags section in the documentation is named Mypy internals in --help.
    (FIXED)

  • --raise-exceptions option is not mentioned in the documentation.
    (FIXED)

  • In Report generation section the order of options is different in the documentation and in --help.
    (FIXED)

  • --junit-xml belongs to section Report generation in the documentation, but to section Miscellaneous in --help.
    (FIXED)

  • --lineprecision-report, --memory-xml-report, --xml-report options are not mentioned in the documentation.
    (FIXED, requires followup after Some Report generation options are undocumented #7775 is resolved)

  • In Miscellaneous section, --scripts-are-modules option goes before --find-occurrences in the documentation, but after it in --help.
    (FIXED)

  • --verbose, --version options are not mentioned in the documentation.
    (FIXED)

Metadata

Metadata

Assignees

No one assigned

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions