summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBar Harel <bharel@barharel.com>2023-05-31 22:56:06 (GMT)
committerGitHub <noreply@github.com>2023-05-31 22:56:06 (GMT)
commitf332594dd47947612e1e5d2faf287930552a5110 (patch)
tree299ab97f141b4502b3b738afd7f2c710b86394ec
parenta99b9d911e0f8cb11b3436bdd8eb649b15d01a50 (diff)
downloadcpython-f332594dd47947612e1e5d2faf287930552a5110.zip
cpython-f332594dd47947612e1e5d2faf287930552a5110.tar.gz
cpython-f332594dd47947612e1e5d2faf287930552a5110.tar.bz2
gh-105172: Fixed functools.lru_cache typed argument docstring. (GH-105173)
-rw-r--r--Lib/functools.py5
-rw-r--r--Misc/NEWS.d/next/Documentation/2023-05-31-23-05-51.gh-issue-105172.SVfvkD.rst2
2 files changed, 5 insertions, 2 deletions
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.