Skip to content

Clean up @deprecated spec #2044

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
srittau merged 1 commit into from
Jul 15, 2025
Merged

Clean up @deprecated spec #2044

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion docs/spec/directives.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,8 @@ The decorator takes the following arguments:

* A required positional-only argument representing the deprecation message.
* Two keyword-only arguments, ``category`` and ``stacklevel``, controlling
runtime behavior (see under "Runtime behavior" below).
runtime behavior. These are not relevant to type checker behavior so they are
not further described in this specification.

The positional-only argument is of type ``str`` and contains a message that should
be shown by the type checker when it encounters a usage of the decorated object.
Expand Down