2e1f688fe0
gh-107891: Fix typo in 3.12 whatsnew ( #107892 )
2023-08-12 12:05:22 +00:00
66e4edd734
gh-91051: fix segfault when using all 8 type watchers ( #107853 )
2023-08-11 12:42:26 -06:00
637f7ff2c6
Docs: Document PyBUF_MAX_NDIM ( #107865 )
2023-08-11 18:03:53 +02:00
23a6db98f2
gh-107421: Clarify `OrderedDict` Examples and Recipes ( #107613 )
2023-08-10 23:43:13 -05:00
a9caf9cf90
GH-105848: Simplify the arrangement of CALL's stack (GH-107788)
2023-08-09 18:19:39 +00:00
34cafd35e3
Docs: clean up Argument Clinic howto's ( #107797 )
...
- fix formatting in @text_signature howto and NEWS entry
- fix formatting and example text in deprecate-positionals howto
2023-08-09 09:43:02 +02:00
0be3743f54
gh-104683: Add --exclude option to Argument Clinic CLI ( #107770 )
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-08 20:50:54 +00:00
aab6f7173a
GH-100425: Note improved commutativity in sum(). (GH-107785)
2023-08-08 18:30:33 +01:00
a9aeb99579
gh-86457: Add docs for Argument Clinic @text_signature directive ( #107747 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-08-08 08:42:08 +02:00
5dc825d504
gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552)
...
PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts. In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has.
This change updates the documentation to reflect that perspective. It also updates the docs relative to immortal objects in a handful of places.
2023-08-07 15:40:59 -06:00
8c9af6b9a0
Docs: Fix more Sphinx annotations in ctypes.rst ( #107708 )
2023-08-07 15:11:05 +02:00
33cb0b06ef
gh-95065: Add Argument Clinic support for deprecating positional use of parameters ( #95151 )
...
It is now possible to deprecate passing parameters positionally with
Argument Clinic, using the new '* [from X.Y]' syntax.
(To be read as "keyword-only from Python version X.Y")
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-07 11:28:08 +00:00
6925c578a0
gh-107442: Document all valid types for ctypes _as_parameter_ ( #107443 )
2023-08-07 12:41:39 +02:00
a6675b1a59
Docs: Argument Clinic: Move the CConverter class to the reference ( #107671 )
2023-08-07 02:08:34 +02:00
4e242d1ffb
Improve cross-references in `runpy` docs ( #107673 )
...
- Add links to `__main__` and `sys.path` where appropriate
- Ensure each paragraph never has more than one link to the same thing, to avoid visual clutter from too many links
2023-08-06 21:11:16 +00:00
9564e31cbc
Do not use deprecated ``logger.warn()`` in pyspecific ( #107694 )
2023-08-06 13:58:00 +00:00
9641c4d8e2
Docs: skip python-docs-theme 2023.7 to fix mobile menu ( #107666 )
2023-08-06 13:08:32 +02:00
71a7c96ffe
Docs: Fix Sphinx annotations in Doc/library/ctypes.rst ( #107672 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-06 10:23:50 +02:00
ecb05e0b98
GH-84435: Make pyspecific directives translatable ( #19470 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-05 23:10:50 -06:00
4a5b4221e3
Docs: Argument Clinic: Improve 'How to write a custom converter' ( #107328 )
...
- Omit unneccesary wording and sentences
- Don't mention implementation details (no digression, explanation)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-08-05 20:19:37 +00:00
9ebc6ecbc3
gh-107662: Switch 'any' and 'anext' in functions.rst ( #107663 )
...
Order was reversed in index at top, not in body.
2023-08-05 14:38:20 +00:00
5e2746d6e2
gh-107432 Fix incorrect indentation in annotations HOWTO ( #107445 )
...
gh-107432 Fix incorrect indentation in annotations document
Body text in https://docs.python.org/3/howto/annotations.html was
indented throughout, and was being rendered in blockquote elements.
2023-08-05 14:28:28 +03:00
ec0a0d2bd9
GH-70303: Emit FutureWarning when pathlib glob pattern ends with `**` (GH-105413)
...
In a future Python release, patterns with this ending will match both files
and directories. Users may add a trailing slash to remove the warning.
2023-08-04 23:12:12 +00:00
904b5319b3
Docs: Only include Plausible for html, not for epub etc ( #107637 )
...
Only include Plausible for html, not for epub etc
2023-08-04 21:33:34 +03:00
09a8cc7984
gh-107600: Docs: Update ctypes.ArgumentError error message ( #107601 )
2023-08-04 16:34:04 +02:00
19f32b24b2
Docs: upgrade to python-docs-theme 2023.7 ( #107617 )
2023-08-04 14:16:10 +00:00
fa45958450
GH-107263: Increase C stack limit for most functions, except `_PyEval_EvalFrameDefault()` (GH-107535)
...
* Set C recursion limit to 1500, set cost of eval loop to 2 frames, and compiler mutliply to 2.
2023-08-04 10:10:29 +01:00
dd693d6320
gh-105481: simplify definition of pseudo ops in Lib/opcode.py ( #107561 )
2023-08-02 18:16:57 +01:00
c8872f4285
Clarify `Self` interaction with subclasses ( #107511 )
2023-08-01 13:20:25 -07:00
6ef8f8ca88
gh-105481: the ENABLE_SPECIALIZATION flag does not need to be generated by the build script, or exposed in opcode.py ( #107534 )
2023-08-01 17:05:00 +00:00
79e479c45f
gh-99113: Add a What's New Entry for PEP 684 (gh-107520)
2023-07-31 23:13:55 +00:00
db361a340a
gh-105766: Document that Custom Allocators Must Be Thread-Safe (gh-107519)
2023-07-31 23:11:15 +00:00
fb344e99aa
gh-107306: Add a Doc Entry for Py_mod_multiple_interpreters ( #107403 )
...
It was added in 3.12 for PEP 684 (per-interpreter GIL).
2023-07-31 17:03:01 -06:00
abb71c6a8f
gh-107507: Replace 'The goals of Argument Clinic' with a summary ( #107508 )
...
Summarise the goals of Argument Clinic in a single sentence.
Mention that Argument Clinic was introduced with PEP-436.
2023-07-31 23:33:13 +02:00
de51dede5b
gh-106762: Add news for `EnumMeta.__getattr__` removal (GH-107466)
2023-07-31 10:24:44 -07:00
a22ff8e11c
gh-105578: Document that `AnyStr` is deprecated in py313 ( #107116 )
...
It will not be removed until Python 3.18.
2023-07-31 15:43:53 +00:00
f877b32b87
gh-105578: Add more usage examples to `typing.AnyStr` docs ( #107045 )
...
``typing.AnyStr`` has different semantics to ``str | bytes``, which often leads to user confusion
2023-07-31 16:23:08 +01:00
83e0976f89
gh-99079: Update macOS installer to use OpenSSL 3.0.9. (GH-107474)
2023-07-31 05:58:35 +00:00
a24e25d74b
gh-107427: Update the description of UNPACK_SEQUENCE (gh-107429)
2023-07-31 00:40:37 +09:00
f2abeb590d
Fix the documentation for PyCode_New add `qualname` parameter ( #107186 )
2023-07-29 23:11:40 +05:30
89fd4f4a3f
gh-107422: Remove outdated `TypedDict` example from typing docs ( #107436 )
2023-07-29 17:04:46 +00:00
37551c9cef
gh-107369: optimize textwrap.indent() ( #107374 )
2023-07-29 06:37:23 +00:00
f2d07d3289
gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386)
2023-07-29 08:48:10 +03:00
413ba8943e
gh-107091: Fix some uses of :func: role (GH-107378)
...
:c:func: or :c:macro: should be used instead.
2023-07-29 08:43:10 +03:00
cf63df88d3
gh-107307: Update the importlib Docs for PEP 684 (gh-107400)
2023-07-28 16:00:03 -06:00
c0b81c4b54
gh-107305: Update the C-API Docs for PEP 684 (gh-107324)
2023-07-28 13:46:55 -06:00
1ee605c588
GH-101291: Add warning to "what's new" that `PyLongObject` internals have changed. (GH-107388)
2023-07-28 17:07:33 +01:00
0aa58fa7a6
gh-107091: Fix some uses of :const: role (GH-107379)
...
It is for references, not for literals.
2023-07-28 13:26:28 +03:00
983305268e
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
9a7204b86b
gh-105268: _PyGC_FINALIZED() removal is already documented in 3.12 ( #107350 )
2023-07-27 14:43:09 +00:00
f84d77b4e0
Bump some docs dependencies to resolve a Dependabot security alert ( #107341 )
2023-07-27 11:53:21 +00:00
ccd4253752
gh-106996: Rewrite turtle explanation ( #107244 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-27 11:02:19 +03:00
abec9a1b20
gh-107298: Docs: add targets for some :c:member: and :c:macro: references (GH-107316)
...
Add targets for PyStructSequence_Desc and PyStructSequence_Field members
and macros like Py_EQ.
Fix target for Py_RETURN_RICHCOMPARE.
2023-07-27 09:04:02 +03:00
d363eb5b02
gh-107091: Fix some uses of :attr: role (GH-107318)
...
Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
8d61a71f9c
gh-107298: Fix more Sphinx warnings in the C API doc ( #107329 )
...
Declare the following functions as macros, since they are actually
macros. It avoids a warning on "TYPE" or "macro" argument.
* PyMem_New()
* PyMem_Resize()
* PyModule_AddIntMacro()
* PyModule_AddStringMacro()
* PyObject_GC_New()
* PyObject_GC_NewVar()
* PyObject_New()
* PyObject_NewVar()
Add C standard C types to nitpick_ignore in Doc/conf.py:
* int64_t
* uint64_t
* uintptr_t
No longer ignore non existing "__int" type in nitpick_ignore.
Update Doc/tools/.nitignore
2023-07-27 00:52:40 +00:00
391e03fa05
gh-107298: Fix Sphinx warnings in the C API doc ( #107302 )
...
* Update Doc/tools/.nitignore
* Fix BufferedIOBase.write() link in buffer.rst
2023-07-27 01:41:15 +02:00
2ad699002e
Docs: Argument Clinic: Restructure "Basic concepts and usage" ( #106981 )
...
Split "Basic concepts and usage" into:
- Reference
- Terminology
- CLI reference
- Background
- Basic concepts
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-07-26 22:08:43 +00:00
592395577c
Docs: Remove the numbered steps from the Argument Clinic tutorial ( #107203 )
...
Instead, order the tutorial as one body of prose, making it easier to
align the tutorial according to Diátaxis principles.
2023-07-26 22:54:25 +02:00
6d5b6e71c8
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +03:00
af61cb9c78
gh-107091: Fix some uses of :c:member: role (GH-107129)
2023-07-26 22:16:06 +03:00
737d1da074
Document that `os.link()` is not available on Emscripten (GH-104822)
2023-07-26 11:38:59 -07:00
87b39028e5
gh-107298: Fix doc references to undocumented modules ( #107300 )
...
Update also Doc/tools/.nitignore.
2023-07-26 18:59:06 +02:00
b1de3807b8
gh-106948: Update documentation nitpick_ignore for c:identifer domain ( #107295 )
...
Update the nitpick_ignore of the documentation configuration to fix
Sphinx warnings about standard C types when declaring functions with
the "c:function" markups.
Copy standard C types declared in the "c:type" domain to the
"c:identifier" domain, since "c:function" markup looks for types in
the "c:identifier" domain.
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-26 18:04:46 +02:00
da8f87b7ea
gh-107015: Remove async_hacks from the tokenizer ( #107018 )
2023-07-26 16:34:15 +01:00
70dc009469
gh-106939: document ShareableList nul-strip quirk. ( #107266 )
...
* gh-106939: document ShareableList nul-strip quirk.
* Mention the `int` size constraint.
2023-07-25 14:09:25 -07:00
2425346fee
gh-106996: Add a how-to section to the turtle documentation ( #107153 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-25 15:03:57 +03:00
329e4a1a3f
gh-86493: Modernize modules initialization code (GH-106858)
...
Use PyModule_Add() or PyModule_AddObjectRef() instead of soft deprecated
PyModule_AddObject().
2023-07-25 14:34:49 +03:00
ff5f94b72c
Docs: Add missing markup to Argument Clinic docs ( #106876 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-24 15:22:18 +00:00
0a9b339363
Fix PyVectorcall_Function doc versionadded ( #107140 )
...
The documentation implies that PyVectorcall_Function() was available in Python 3.8.
This is half-true - it was available under a different name. I think it's clearer to set
the "version added" to 3.9.
2023-07-24 14:54:38 +02:00
ebe44a5155
Docs: Remove duplicate word in Argument Clinic howto heading ( #107169 )
2023-07-24 13:54:39 +02:00
2cf99026d6
gh-107017: Change Chapter Strings to Texts in the Introduction chapter. ( #107104 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-24 05:55:57 +00:00
7ca2d8e053
gh-105291: Add link to migration guide for distutils ( #107130 )
...
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-07-23 14:50:01 -07:00
b447e19e72
gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls ( #107062 )
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-23 22:56:56 +02:00
956b3de816
Remove superflous whitespaces in `layout.html`. (GH-107067)
2023-07-23 17:18:50 +02:00
d1b839b453
gh-107122: Update what's news for dbm.*dbm.clear() method (gh-107135)
2023-07-24 00:08:50 +09:00
0ae4870d09
gh-107122: Add clear method to dbm.ndbm module (gh-107126)
2023-07-23 14:26:23 +00:00
b273837fea
gh-107122: Add clear method to dbm.gdbm.module (gh-107127)
2023-07-23 13:51:12 +00:00
e59da0c4f2
gh-107017: Analolgy to Pascal and C replaced. ( #107025 )
...
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-07-23 06:07:24 -06:00
08a228da05
gh-107091: Fix the use of some C domain roles ( #107092 )
2023-07-23 12:27:05 +02:00
a2a0e51400
gh-106996: Add the basics of a turtle graphics tutorial ( #107072 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-23 03:43:27 -06:00
102a773716
gh-106976: alphabetise bullets by module name task2-3 ( #107005 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-23 09:41:34 +00:00
f5147c0cfb
gh-101100: Fix some broken sphinx references ( #107095 )
2023-07-23 03:23:44 -06:00
dcd7acb04a
gh-54738: Add argparse i18n howto ( #104562 )
2023-07-23 11:10:38 +02:00
680f3e1591
gh-71261: Add paragraph on shadowing submodules with star imports ( #107004 )
2023-07-23 03:00:42 -06:00
9629d4442e
gh-107017: removed mention that C does it the same way ( #107020 )
2023-07-23 02:57:52 -06:00
0af247da09
gh-102111: Add link to string escape sequences in re module ( #106995 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-07-23 02:50:38 -06:00
5e5a34ac3a
gh-107028: tiny textual changes in logging docs and docstrings (GH-107029)
2023-07-22 21:43:18 +01:00
f8b7fe2f26
gh-106948: Add standard external names to nitpick_ignore (GH-106949)
...
It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH".
2023-07-22 21:35:22 +03:00
26e08dfdd7
gh-107008: Document the curses module variables LINES and COLS (GH-107011)
...
LINES and COLS referred in curses.update_lines_cols() documentations are
the module variables, not the environment variables.
2023-07-22 19:54:50 +03:00
6e5f2235f3
gh-83006: Document behavior of `shutil.disk_usage` for non-mounted filesystems on Unix ( #107031 )
2023-07-22 17:58:06 +02:00
149748ea4f
Fix Sphinx warnings in `re` module docs ( #107044 )
2023-07-22 16:44:44 +01:00
c92ef6fe0e
gh-106967: remove Release and Date fields from whatsnew for 3.12 and 3.13 ( #107000 )
2023-07-22 14:57:51 +00:00
e5252c6127
gh-105090: Replace incorrect TLSv1.2 with TLSv1.3 ( #105404 )
2023-07-22 14:29:08 +00:00
756add081e
gh-106320: Document private C API removal in What's New 3.13 ( #107027 )
2023-07-22 15:30:13 +02:00
ed491d9f78
Reformat code block to make it easier to read ( #106965 )
2023-07-22 14:19:30 +02:00
6dbffaed17
gh-106969: Indicate no modules were added in 3.10 & 3.12 ( #106988 )
...
The "New Modules" section was left in place to ensure that the anchor
link for new modules will still exist:
/whatsnew/3.12.html#new-modules
/whatsnew/3.10.html#new-modules
This means that existing links to this section don't break.
2023-07-22 14:13:44 +02:00
f8f16d0cfc
gh-106996: Amend the introduction to the turtle graphics documentation ( #106997 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-22 04:31:44 -06:00
443d9b3033
gh-106976:alphabetise bullets by module name task1 ( #106982 )
2023-07-22 10:34:48 +02:00
d55b4da10c
gh-106973: Change non-integral to non-integer in "3.12 What's New" ( #106984 )
2023-07-22 02:27:48 -06:00
806d7c98a5
gh-101100: Docs: Check Sphinx warnings and fail if improved ( #106460 )
2023-07-22 08:12:43 +00:00
wookie184
Carl Meyer
Erlend E. Aasland
shailshouryya
Brandt Bucher
Raymond Hettinger
Eric Snow
Tomas R
Kamil Turek
Adam Turner
Hugo van Kemenade
cocoatomo
Terry Jan Reedy
Daniele Procida
Barney Gale
Mark Shannon
Irit Katriel
Alexandru Mărășteanu
Jacob Walls
Michael The
Ned Deily
Dong-hee Na
da-woods
Rakesh Sabale
Inada Naoki
Serhiy Storchaka
Victor Stinner
Alex Waygood
Roman Yurchak
Pablo Galindo Salgado
Gregory P. Smith
Hakan Celik
TommyUnreal
cLupus
Ezio Melotti
littlebutt's workshop
wulmer
Jakub Červinka
Jochem Boersma
Matthieu Caneill
Oliver Rew
Jocelyn Castellano
Joe Kaufeld
Sebastiaan Zeeff