https://github.com/python/cpython/commit/bb057ea1075e000ff3f0d6b27a2b7ca4117b4969
commit: bb057ea1075e000ff3f0d6b27a2b7ca4117b4969
branch: main
author: Bénédikt Tran <[email protected]>
committer: AlexWaygood <[email protected]>
date: 2024-06-25T07:59:56Z
summary:
gh-120661: improve example for basic type hints (#120934)
files:
M Doc/library/typing.rst
diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index 07b6e342e09195..7d1d317b9f8f8a 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
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
