From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 25 Jun 2024 08:25:11 +0000 (+0200)
Subject: [3.12] gh-120661: improve example for basic type hints (GH-120934) (#120988)
X-Git-Tag: v3.12.5~170
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=566898a3f6af4d59baf4a4fe914dd29a4c46fb85;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-120661: improve example for basic type hints (GH-120934) (#120988)

gh-120661: improve example for basic type hints (GH-120934)
(cherry picked from commit bb057ea1075e000ff3f0d6b27a2b7ca4117b4969)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
---

diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index 86c4dc303c30..83956a6a9fb9 100644
--- a/Doc/library/typing.rst
+++ b/Doc/library/typing.rst
@@ -27,12 +27,13 @@ This module provides runtime support for type hints.
 
 Consider the function below::
 
-   def moon_weight(earth_weight: float) -> str:
-       return f'On the moon, you would weigh {earth_weight * 0.166} kilograms.'
+   def surface_area_of_cube(edge_length: float) -> str:
+       return f"The surface area of the cube is {6 * edge_length ** 2}."
 
-The function ``moon_weight`` takes an argument expected to be an instance of :class:`float`,
-as indicated by the *type hint* ``earth_weight: float``. The function is expected to
-return an instance of :class:`str`, as indicated by the ``-> str`` hint.
+The function ``surface_area_of_cube`` takes an argument expected to
+be an instance of :class:`float`, as indicated by the :term:`type hint`
+``edge_length: float``. The function is expected to return an instance
+of :class:`str`, as indicated by the ``-> str`` hint.
 
 While type hints can be simple classes like :class:`float` or :class:`str`,
 they can also be more complex. The :mod:`typing` module provides a vocabulary of