docs: typing.Self, fix typo (GH-94771)

* fix typo - double spelled word 'use'

* change methods names to the infinitive form
This commit is contained in:
Max Zhenzhera 2022-07-12 20:45:52 +03:00 committed by GitHub
parent 0c66074e9f
commit 90a6e56e56
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 4 deletions

View file

@ -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
@ -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
@ -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:

View file

@ -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