c69da47ac9
[3.11] gh-115572: Move `codeobject.replace()` docs to the data model … ( #115632 )
...
* [3.11] gh-115572: Move `codeobject.replace()` docs to the data model (GH-115631)
(cherry picked from commit 0c80da4c14
2024-02-18 14:37:27 +00:00
0af16e3dc6
[3.11] gh-115405: add versionadded tag for co_qualname in code objects documentation (GH-115411) ( #115413 )
...
gh-115405: add versionadded tag for co_qualname in code objects documentation (GH-115411)
(cherry picked from commit de07941729
2024-02-13 16:16:22 +00:00
089cae5158
[3.11] gh-114552: Update `__dir__` method docs: it allows returning an iterable (GH-114662) ( #115235 )
...
gh-114552: Update `__dir__` method docs: it allows returning an iterable (GH-114662)
(cherry picked from commit e19103a346
2024-02-10 08:54:43 +00:00
3681effafb
[3.11] Fix the confusing "User-defined methods" reference in the datamodel (GH-114276) ( #114366 )
2024-01-21 03:52:30 +00:00
cd8fd2292e
[3.11] datamodel: Fix a typo in ``object.__init_subclass__`` (GH-111599) ( #114005 )
...
datamodel: Fix a typo in ``object.__init_subclass__`` (GH-111599)
(cherry picked from commit a47353d587
2024-01-12 23:06:14 +00:00
f8dd29030d
[3.11] Docs: Amend codeobject.co_lines docs; end number is exclusive (GH-113970) ( #113988 )
...
The end number should be exclusive, not inclusive.
(cherry picked from commit e68806c712
2024-01-12 15:10:33 +00:00
c92a473a71
[3.11] gh-113664: Improve style of Big O notation (GH-113695) (GH-113910)
...
Use cursive to make it looking like mathematic formulas.
(cherry picked from commit a8629816c6
2024-01-10 13:13:27 +00:00
c828dbc196
[3.11] Document the `co_lines` method on code objects ( #113682 ) ( #113687 )
...
(cherry-picked from commit f1f8392432
2024-01-03 19:59:10 +00:00
beb1c6506c
[3.11] gh-113313: Note that slice support is not required for all sequences. (gh-113377) (gh-113383)
2023-12-21 22:01:25 +00:00
899f1c082c
[3.11] Fix typo in datamodel docs (GH-113314) ( #113315 )
...
Fix typo in datamodel docs (GH-113314)
(cherry picked from commit 5a7cc667f8
2023-12-20 12:04:59 +00:00
9b3447ca3c
[3.11] gh-101100: Improve docs on exception attributes (GH-113057) ( #113062 )
...
gh-101100: Improve docs on exception attributes (GH-113057)
(cherry picked from commit d05a180350
2023-12-13 19:07:19 +00:00
b8a6eeec39
[3.11] gh-101100: Further improve docs on function attributes ( #113001 ) ( #113031 )
...
(cherry-picked from commit 81a15ea74e
2023-12-12 20:36:51 +00:00
f83087ce03
[3.11] gh-101100: Improve documentation on function attributes ( #112933 ) ( #113003 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-12 14:19:02 +02:00
c95aa4e310
[3.11] gh-101100: Improve documentation of `TracebackType` attributes (GH-112884) ( #112912 )
...
gh-101100: Improve documentation of `TracebackType` attributes (GH-112884)
(cherry picked from commit 96f64a2b1b
2023-12-09 22:50:01 +00:00
161cfd0dda
[3.11] gh-101100: Improve documentation for attributes on instance methods (GH-112832) ( #112873 )
...
gh-101100: Improve documentation for attributes on instance methods (GH-112832)
(cherry picked from commit ed21d0c1f4
2023-12-08 13:25:05 +00:00
5fa2d24002
[3.11] gh-101100: Improve documentation of code object attributes ( #112781 ) ( #112817 )
...
(cherry-picked from commit e9707d3c3d
2023-12-06 22:23:20 +00:00
c26d6c1aba
[3.11] gh-101100: Properly document frame object attributes ( #112735 ) ( #112775 )
...
* [3.11] gh-101100: Properly document frame object attributes (#112735 )
(cherry-picked from commit d109f637c0
2023-12-05 20:23:25 +00:00
80c314c9ce
[3.11] gh-101100: Fix many easily solvable Sphinx nitpicks in the datamodel docs (GH-112737) ( #112749 )
...
gh-101100: Fix many easily solvable Sphinx nitpicks in the datamodel docs (GH-112737)
(cherry picked from commit 2f20cafdbf
2023-12-05 10:06:30 +00:00
05ea7e5d4d
[3.11] gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662) ( #112667 )
...
gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662)
(cherry picked from commit 45650d1c47
2023-12-03 17:39:10 +00:00
f22cdecb19
[3.11] GH-101100: Fix reference warnings for ``__enter__`` and ``__exit__`` (GH-110112) ( #111076 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-19 18:34:27 +03:00
5505bfd687
[3.11] Datamodel: Add headings to the standard type hierarchy (GH-108146) ( #108484 )
...
* [3.11] Datamodel: Add headings to the standard type hierarchy (GH-108146)
Dedent content according to the new layout..
(cherry picked from commit 2b7bff0655
2023-08-25 18:27:34 +03:00
8cf3cae8c5
[3.11] Docs: Datamodel: Merge "Notes on using __slots__" with the parent section (GH-108400) ( #108475 )
...
(cherry picked from commit 7f5b1a0661
2023-08-25 13:04:00 +02:00
3c1bcae075
[3.11] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) (GH-107418)
...
(cherry picked from commit f2d07d3289
2023-07-29 09:17:20 +03:00
cc76113cf8
[3.11] gh-106892: Use roles :data: and :const: for referencing module variables (GH-106894) (GH-106955)
...
(cherry picked from commit d036db728e
2023-07-21 14:49:21 +03:00
4b11af058e
[3.11] GH-97950: Use new-style index directive ('builtin') (GH-104164) ( #104221 )
...
GH-97950: Use new-style index directive ('builtin') (GH-104164)
* Uncomment builtin removal in pairindextypes
* Use new-style index directive ('builtin') - C API
* Use new-style index directive ('builtin') - Extending
* Use new-style index directive ('builtin') - Library
* Use new-style index directive ('builtin') - Reference
* Use new-style index directive ('builtin') - Tutorial
(cherry picked from commit f5088006ca
2023-05-06 07:14:37 +03:00
6a970ae666
[3.11] GH-97950: Use new-style index directive ('statement') (GH-104162) ( #104163 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 13:57:14 +03:00
c463796ba7
[3.11] GH-97950: Use new-style index directive ('object') (GH-104158) ( #104159 )
...
GH-97950: Use new-style index directive ('object') (GH-104158)
* Uncomment object removal in pairindextypes
* Use new-style index directive ('object') - C API
* Use new-style index directive ('object') - Library
* Use new-style index directive ('object') - Reference
* Use new-style index directive ('object') - Tutorial
(cherry picked from commit 6ab463684b
2023-05-04 13:14:16 +03:00
00563694bb
[3.11] GH-97950: Use new-style index directive ('module') (GH-103996) ( #104154 )
2023-05-04 11:39:15 +03:00
5e76305236
[3.11] GH-103484: Fix redirected permanently URLs (GH-104001) ( #104088 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
Fix redirected permanently URLs (#104001 )
2023-05-02 14:50:16 +03:00
07a2851edb
gh-103373: `__mro_entries__` docs: improve cross references (GH-103398)
...
(cherry picked from commit e071f00aae
2023-04-11 03:34:46 -07:00
77359a86b8
gh-103373: Improve documentation for `__mro_entries__` (GH-103374)
...
(cherry picked from commit 0ba0ca05d2
2023-04-08 07:16:43 -07:00
1f7eb8fe6c
gh-100315: clarification to `__slots__` docs. (GH-102621)
...
refer to tp_itemsize in discussion on "variable-length" built-in types
(cherry picked from commit 88c262c086
2023-03-14 02:32:09 -07:00
78eee76185
gh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (GH-102012)
...
(cherry picked from commit 4d3bc89a3f
2023-02-21 03:06:20 -08:00
4aeae28671
GH-101898: Fix missing term references for hashable definition (GH-101899)
...
Fix missing term references for hashable definition
(cherry picked from commit 3690688149
2023-02-14 02:45:42 -08:00
f9ddbc0de5
GH-85979: Clarify specification of `object.__await__` (GH-22320)
...
(cherry picked from commit f59c7f8edd
2022-12-30 22:34:12 -08:00
0006d9bf7b
Fix typo in `__match_args__` doc (GH-99785)
...
A opy of GH-98549, whose author (@icecream17) uses a school computer that blocks the CLA site. I did not mention this in commit comment above so CLA bot does not pick up the name and request the CLA again.
(cherry picked from commit a86d854522
2022-11-25 16:10:48 -08:00
5f86275ec2
[3.11] Change links to label refs (GH-98454) ( #98725 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 268129a74f
2022-10-26 13:18:50 -07:00
83ad76275c
[3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) ( #97924 )
...
:c:type:`<C type>` -> :c:expr:`<C type>`
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0031e62973
2022-10-05 14:11:12 -07:00
77bf973930
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94557)
...
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
(cherry picked from commit 3440d197a5
2022-07-05 14:30:19 +02:00
8be7c2bc5a
bpo-14911: Corrected generator.throw() documentation (GH-32207)
...
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
2022-03-31 16:56:48 +03:00
3af68fc77c
bpo-46013: Fix confusing kerning on period in docs (GH-29989)
2022-03-20 09:58:13 +00:00
ab014978ae
Removed ambiguity in __init_subclass__ docs (GH-31540)
2022-03-07 20:13:01 -08:00
b4bd1e1422
bpo-44977: Deprecate delegation of int to __trunc__ (GH-31031)
...
Calling int(a) when type(a) implements __trunc__ but not __int__
or __index__ now raises a DeprecationWarning.
2022-02-03 11:43:25 +02:00
aeb9ef4c72
bpo-46076: Improve documentation for per-attribute docstrings with `__slots__` (GH-30109)
2021-12-19 14:20:07 -06:00
3ea574f35b
Fix some false positives of documentation syntax problems
2021-12-08 22:22:55 +00:00
4ccccb1cfc
bpo-20751: Match variable name to the example. (GH-29980)
2021-12-07 21:38:21 -06:00
c0521fe49f
bpo-45840: Improve cross-references in the data model documentation (GH-29633)
2021-12-05 22:49:36 +02:00
135ecc3492
bpo-20751: Replace method example with attribute example, matching the descriptor howto (GH-29909)
2021-12-03 20:37:08 -06:00
ee49484c0f
[doc] Clarify MRO precedence in descriptor super binding section (GH-29539)
...
A similar sentence is present in the 'Invocation from super' section of
the descriptor HOWTO, where it is already correct.
2021-11-20 17:55:35 +01:00
be36e06340
bpo-45250: fix docs regarding `__iter__` and iterators being inconsistently required by CPython (GH-29170)
...
It is now considered a historical accident that e.g. `for` loops and the `iter()` built-in function do not require the iterators they work with to define `__iter__`, only `__next__`.
2021-11-19 16:40:34 -08:00
Kirill Podoprigora