From f332594dd47947612e1e5d2faf287930552a5110 Mon Sep 17 00:00:00 2001 From: Bar Harel Date: Wed, 31 May 2023 23:56:06 +0100 Subject: gh-105172: Fixed functools.lru_cache typed argument docstring. (GH-105173) --- Lib/functools.py | 5 +++-- .../Documentation/2023-05-31-23-05-51.gh-issue-105172.SVfvkD.rst | 2 ++ 2 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 Misc/NEWS.d/next/Documentation/2023-05-31-23-05-51.gh-issue-105172.SVfvkD.rst diff --git a/Lib/functools.py b/Lib/functools.py index 72b2103..4d5e270 100644 --- a/Lib/functools.py +++ b/Lib/functools.py @@ -483,8 +483,9 @@ def lru_cache(maxsize=128, typed=False): can grow without bound. If *typed* is True, arguments of different types will be cached separately. - For example, f(3.0) and f(3) will be treated as distinct calls with - distinct results. + For example, f(decimal.Decimal("3.0")) and f(3.0) will be treated as + distinct calls with distinct results. Some types such as str and int may + be cached separately even when typed is false. Arguments to the cached function must be hashable. diff --git a/Misc/NEWS.d/next/Documentation/2023-05-31-23-05-51.gh-issue-105172.SVfvkD.rst b/Misc/NEWS.d/next/Documentation/2023-05-31-23-05-51.gh-issue-105172.SVfvkD.rst new file mode 100644 index 0000000..96cf722 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2023-05-31-23-05-51.gh-issue-105172.SVfvkD.rst @@ -0,0 +1,2 @@ +Fixed :func:`functools.lru_cache` docstring accounting for ``typed`` +argument's different handling of str and int. Patch by Bar Harel. -- cgit v0.12