Skip to content

docs: typing.Self, fix typo #94771

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
Fidget-Spinner merged 3 commits into from
Jul 12, 2022
Merged

docs: typing.Self, fix typo #94771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
38c49bd
docs: typing.Self, fix typo - double spelled word 'use'
maxzhenzhera Jul 12, 2022
d031ecf
docs: typing.Self, change methods names to the infinitive form
maxzhenzhera Jul 12, 2022
8c794d1
docs: typing.Self, change method name to the infinitive form
maxzhenzhera Jul 12, 2022
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
6 changes: 3 additions & 3 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -683,7 +683,7 @@ These can be used as types in annotations and do not support ``[]``.
from typing import Self

class Foo:
def returns_self(self) -> Self:
def return_self(self) -> Self:
...
return self

Expand All @@ -696,7 +696,7 @@ These can be used as types in annotations and do not support ``[]``.
Self = TypeVar("Self", bound="Foo")

class Foo:
def returns_self(self: Self) -> Self:
def return_self(self: Self) -> Self:
...
return self

Expand All @@ -707,7 +707,7 @@ These can be used as types in annotations and do not support ``[]``.
...
return self

You should use use :data:`Self` as calls to ``SubclassOfFoo.returns_self`` would have
You should use :data:`Self` as calls to ``SubclassOfFoo.return_self`` would have
``Foo`` as the return type and not ``SubclassOfFoo``.

Other common use cases include:
Expand Down
2 changes: 1 addition & 1 deletion Lib/typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@ def Self(self, parameters):
from typing import Self

class Foo:
def returns_self(self) -> Self:
def return_self(self) -> Self:
...
return self

Expand Down