Erlend E. Aasland
1d7bddd961
Docs: align usage of versionadded/versionchanged with recommended practice ( #114409 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2024-01-22 21:40:26 +00:00
Rodrigo Girão Serrão
4de468cce1
`functools.partial` docs: Use the more common spelling for "referenceable" ( #113675 )
2024-01-03 12:50:44 +00:00
Xuehai Pan
74f315edd0
gh-102757: fix function signature mismatch for `functools.reduce` between code and documentation ( #102759 )
2023-09-18 10:42:58 -06:00
Hadházy Tamás
1a713eac47
gh-107619: Extend functools LRU cache docs with generators and async functions ( #107934 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2023-08-20 10:33:15 +00:00
Carl Meyer
fa86a77589
gh-104112: link from cached_property docs to method-caching FAQ ( #104113 )
...
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-04 16:38:53 -06:00
Raymond Hettinger
e5eaac6064
GH-103475: cache() and lru_cache() do not have a "call once" guarantee (GH-103669)
2023-04-22 09:18:25 -05:00
Raymond Hettinger
7d20783d45
Minor improvements to the functools docs ( #103672 )
...
* Use an f-string for improved readability
* Put version notes in chronological order
2023-04-21 20:53:50 -05:00
Carl Meyer
056dfc71dc
gh-87634: remove locking from functools.cached_property (GH-101890)
...
Remove the undocumented locking capabilities of functools.cached_property.
2023-02-22 17:49:22 -08:00
Furkan Onder
3690688149
GH-101898: Fix missing term references for hashable definition ( #101899 )
...
Fix missing term references for hashable definition
2023-02-14 14:20:11 +04:00
Julien Palard
66cc46b2e4
Doc: sphinx-lint finds two other default roles. (GH-98019)
2022-10-07 09:10:51 +02:00
Raymond Hettinger
bbc24b2bd5
GH-96851: Add link to FAQ entry for caching method calls. (GH-96902)
2022-09-18 16:36:20 -05:00
Raymond Hettinger
ba4bb7e464
GH-93179: Document the thread safety of functools.lru_cache (GH-95970)
2022-08-18 17:38:49 -05:00
Andrzej Bartosiński
f83b0cabeb
Fix documentation typo for functools.cmp_to_key (GH-95766)
2022-08-08 01:49:48 -05:00
Yurii Karabas
014eb7fd02
bpo-46014: Add docs regarding `functools.singledispatch` changes in 3.11 ( #32282 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-04-18 19:50:59 -07:00
Hugo van Kemenade
6881ea936e
bpo-47126: Update to canonical PEP URLs specified by PEP 676 (GH-32124)
2022-03-30 12:00:27 +01:00
Raymond Hettinger
912a4ccc3a
bpo-45701: Improve documentation for *typed* parameter (GH-29498)
2021-11-09 17:01:29 -06:00
Alex Waygood
71e8a3e76a
bpo-45762: Improve docs for ``@singledispatch``/``@singledispatchmethod`` (GH-29426)
2021-11-05 17:25:08 +01:00
Noah Kantrowitz
be42c06bb0
Update URLs in comments and metadata to use HTTPS (GH-27458)
2021-07-30 15:54:46 +02:00
Raymond Hettinger
fafcfff926
bpo-44310: Note that lru_cache keep references to both arguments and results (GH-26715)
...
* Simplify the count_vowels example
* Hits and misses are fetched while a lock is held
* Add note that references are kept for arguments and return values
* Clarify behavior when *typed* is false.
2021-06-14 00:47:26 -05:00
Raymond Hettinger
c8a7b8fa1b
bpo-42781: Document the mechanics of cached_property from a user viewpoint (GH-24031)
2020-12-31 17:05:58 -08:00
Raymond Hettinger
48be6b1ef7
bpo-42127: Document effect of cached_property on key-sharing dictionaries (GH-22930)
2020-10-24 18:17:17 -07:00
Ben Avrahami
bef7d299eb
bpo-41905: Add abc.update_abstractmethods() (GH-22485)
...
This function recomputes `cls.__abstractmethods__`.
Also update `@dataclass` to use it.
2020-10-06 10:40:50 -07:00
Pablo Galindo
2f172d8f15
bpo-17005: Move topological sort functionality to its own module (GH-20558)
...
The topological sort functionality that was introduced initially in the
functools module has been moved to a new graphlib module to
better accommodate the new tools and keep the original scope of the
functools module.
2020-06-01 00:41:14 +01:00
Allen Guo
3d54211e6e
Fix Wikipedia link (GH-20031)
2020-05-12 19:54:18 -03:00
Raymond Hettinger
21cdb711e3
bpo-40571: Make lru_cache(maxsize=None) more discoverable (GH-20019)
2020-05-11 17:00:53 -07:00
Raymond Hettinger
ad9eaeab74
Remove outdated and confusing advice about setting maxsize (GH-19889)
2020-05-03 16:45:13 -07:00
Pablo Galindo
65ecc390c1
bpo-17005: Minor improvements to the documentation of TopologicalSorter (GH-18155)
2020-01-23 21:01:50 +00:00
Pablo Galindo
99e6c260d6
bpo-17005: Add a class to perform topological sorting to the standard library (GH-11583)
...
Co-Authored-By: Tim Peters <tim.peters@gmail.com>
2020-01-23 15:29:52 +00:00
Batuhan Taşkaya
24555ce2f9
bpo-21767: explicitly mention abc support in functools.singledispatch docs ( #17171 )
2019-11-19 09:16:46 +01:00
Manjusaka
051ff526b5
bpo-38565: add new cache_parameters method for lru_cache (GH-16916)
2019-11-11 23:30:18 -08:00
Serhiy Storchaka
e042a4553e
Do not use explicit inheritance from object in the documentation. (GH-13936)
2019-06-10 13:35:52 +03:00
Serhiy Storchaka
70c5f2ae6e
Use more PEP 570 syntax in the documentation. (GH-13720)
2019-06-01 11:38:24 +03:00
Serhiy Storchaka
2085bd0877
bpo-37116: Use PEP 570 syntax for positional-only parameters. (GH-13700)
2019-06-01 11:00:15 +03:00
Raymond Hettinger
b821868e6d
bpo-36772 Allow lru_cache to be used as decorator without making a function call (GH-13048)
2019-05-26 11:27:35 -07:00
Inada Naoki
bc284f0c7a
bpo-32380: add "versionadded: 3.8" to singledispatchmethod (GH-12580)
2019-03-27 18:15:17 +09:00
Raymond Hettinger
f0e0f2008d
bpo-35300: Add usage note to the lru_cache() docs (GH-10707)
...
https://bugs.python.org/issue35300
2018-11-25 16:24:52 -08:00
Andrei Petre
83a07652e0
bpo-34748: link to :ref:`partial-objects` in functools.partial doc. (GH-9809)
2018-10-23 14:11:20 +08:00
Sergey Fedoseev
b981fec8d6
Use dict unpacking in functools.partial() docs (GH-9412)
2018-10-19 23:42:07 +02:00
Brendan Jurd
9df100286b
Fix name of argument in docs for functools.reduce(). ( #9634 )
2018-09-30 23:52:10 -07:00
Raymond Hettinger
902bcd9a1e
Note that distinct argument patterns can be cached separately (GH-9298)
2018-09-14 00:53:20 -07:00
Carl Meyer
d658deac60
bpo-21145: Add cached_property decorator in functools ( #6982 )
...
Robust caching of calculated properties is
harder than it looks at first glance, so add
a solid, well-tested implementation to the
standard library.
2018-08-28 17:11:56 +10:00
Gerrit Holl
bd81cbd584
DOC: In `reduce`, refer to `accumulate` (GH-7930)
2018-07-04 15:26:32 -07:00
Ethan Smith
c651275afe
bpo-32380: Create functools.singledispatchmethod ( #6306 )
2018-05-26 13:38:33 -07:00
Łukasz Langa
e56975351b
bpo-32227: functools.singledispatch supports registering via type annotations ( #4733 )
2017-12-11 13:56:31 -08:00
Daisuke Miyakawa
0e61e67a57
bpo-31567: add or fix decorator markup in docs ( #3959 )
2017-10-12 10:39:43 -04:00
Serhiy Storchaka
4adf01caae
Issue #19795 : Improved more markups of True/False.
2016-10-19 18:30:05 +03:00
Serhiy Storchaka
ecf41da83e
Issue #19795 : Mark up None as literal text.
2016-10-19 16:29:26 +03:00
Martin Panter
bae5d81f5d
Issue #24314 : Fix doc links for general attributes like __name__, __dict__
2016-06-18 03:57:31 +00:00
Martin Panter
0c0da48aed
Issue #24136 : Document generalized unpacking, PEP 448
...
Based on patches by Konstantin Molchanov and Neil Girdhar.
2016-06-12 01:46:50 +00:00
Terry Jan Reedy
fa089b9b0b
Issue #22558 : Add remaining doc links to source code for Python-coded modules.
...
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00