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.

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

Jump to bottom

Update --no-warn-no-return docs for empty body changes #14065

Merged
merged 3 commits into from Nov 11, 2022
Merged

Update --no-warn-no-return docs for empty body changes #14065

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d6f885
Update --no-warn-no-return docs for empty body changes
hauntsaninja Nov 11, 2022
266bec2
Apply suggestions from code review
hauntsaninja Nov 11, 2022
7cb3116
Update docs/source/command_line.rst
hauntsaninja Nov 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/source/command_line.rst
View file
Open in desktop
Expand Up @@ -448,9 +448,10 @@ potentially problematic or redundant in some way.
are when:

- The function has a ``None`` or ``Any`` return type
- The function has an empty body or a body that is just
ellipsis (``...``). Empty functions are often used for
abstract methods.
- The function has an empty body and is marked as an abstractmethod,
hauntsaninja marked this conversation as resolved.
Show resolved Hide resolved
is in a protocol class, or is in a stub file
- For unreachable execution paths, for example, if an exception
is always raised
hauntsaninja marked this conversation as resolved.
Show resolved Hide resolved

Passing in :option:`--no-warn-no-return` will disable these error
messages in all cases.
Expand Down