Skip to content

Clarify difference between disallow_untyped_defs and disallow_incomplete_defs #15247

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.

Sign up for GitHub

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

Merged
hauntsaninja merged 3 commits into from
May 18, 2023
Merged

Clarify difference between disallow_untyped_defs and disallow_incomplete_defs #15247

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b828fb4
Clarify difference between disallow_untyped_defs and disallow_incompl…
ikonst May 15, 2023
7c8d305
fix typo
ikonst May 15, 2023
702263a
Update help string
ikonst May 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/source/command_line.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,12 +353,17 @@ definitions or calls.
.. option:: --disallow-untyped-defs

This flag reports an error whenever it encounters a function definition
without type annotations.
with without type annotations or with incomplete type annotations.
Copy link
Copy Markdown

@beauxq beauxq May 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this "with" doesn't belong.

Copy link
Copy Markdown
Contributor Author

@ikonst ikonst May 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

7c8d305

(a superset of :option:`--disallow-incomplete-defs`).

For example, it would report an error for :code:`def f(a, b)` and :code:`def f(a: int, b)`.

.. option:: --disallow-incomplete-defs

This flag reports an error whenever it encounters a partly annotated
function definition.
function definition, while still allowing entirely unannotated definitions.

For example, it would report an error for :code:`def f(a: int, b)` but not :code:`def f(a, b)`.

.. option:: --check-untyped-defs

Expand Down
9 changes: 7 additions & 2 deletions docs/source/config_file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,14 +493,19 @@ section of the command line docs.
:default: False

Disallows defining functions without type annotations or with incomplete type
annotations.
annotations (a superset of :confval:`disallow_incomplete_defs`).

For example, it would report an error for :code:`def f(a, b)` and :code:`def f(a: int, b)`.

.. confval:: disallow_incomplete_defs

:type: boolean
:default: False

Disallows defining functions with incomplete type annotations.
Disallows defining functions with incomplete type annotations, while still
allowing entirely unannotated definitions.

For example, it would report an error for :code:`def f(a: int, b)` but not :code:`def f(a, b)`.

.. confval:: check_untyped_defs

Expand Down
⚡