diff options
author | Bénédikt Tran <10796600+picnixz@users.noreply.github.com> | 2024-06-25 07:59:56 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-06-25 07:59:56 (GMT) |
commit | bb057ea1075e000ff3f0d6b27a2b7ca4117b4969 (patch) | |
tree | 620a29938a54c089d619484fc11060afa0ebcc63 | |
parent | 2106c9bef0c18ff35db7d6c083cb8f189507758e (diff) | |
download | cpython-bb057ea1075e000ff3f0d6b27a2b7ca4117b4969.zip cpython-bb057ea1075e000ff3f0d6b27a2b7ca4117b4969.tar.gz cpython-bb057ea1075e000ff3f0d6b27a2b7ca4117b4969.tar.bz2 |
gh-120661: improve example for basic type hints (#120934)
-rw-r--r-- | Doc/library/typing.rst | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 07b6e34..7d1d317 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 |