From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 12 Jul 2022 18:17:06 +0000 (-0700)
Subject: docs: typing.Self, fix typo (GH-94771)
X-Git-Tag: v3.11.0b5~88
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7c185017a9b68c851ea079ef31f6bcef694378ac;p=thirdparty%2FPython%2Fcpython.git

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


* fix typo - double spelled word 'use'

* change methods names to the infinitive form
(cherry picked from commit 90a6e56e5663233fe986331ef3f10422fe57dcbc)

Co-authored-by: Max Zhenzhera <59729293+maxzhenzhera@users.noreply.github.com>
---

diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index fceb43aec9be..ba73d69e8794 100644
--- a/Doc/library/typing.rst
+++ b/Doc/library/typing.rst
@@ -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:
diff --git a/Lib/typing.py b/Lib/typing.py
index 31269273a5c0..9d6babefe6c2 100644
--- a/Lib/typing.py
+++ b/Lib/typing.py
@@ -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