Petr Viktorin
acbd3f9c5c
gh-107845: Fix symlink handling for tarfile.data_filter (GH-107846)
...
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Lumír 'Frenzy' Balhar <frenzy.madness@gmail.com>
2023-08-21 12:56:46 +02:00
Serhiy Storchaka
622ddc4167
Improve references in the tutorial (GH-108069)
...
* Use full qualified names for references (even if they do not work now,
they will work in future).
* Silence references to examples.
2023-08-21 13:41:01 +03:00
Adam Turner
8f3d09bf5d
Resolve reference warnings in faq/gui.rst ( #108147 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-21 07:37:52 +00:00
Adam Turner
6323bc33ff
Resolve reference warnings in faq/library.rst ( #108149 )
...
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-20 19:01:13 +00:00
Adam Turner
92815cc7cf
Resolve reference warnings in faq/design.rst ( #108148 )
2023-08-20 12:34:27 -06:00
Erlend E. Aasland
f904aa4e1f
Docs: document 'manager' and '_log' attrs of logging.Logging ( #108145 )
...
Authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-20 16:01:10 +00:00
Adam Turner
a390ec20f5
Resolve reference warnings in faq/programming.rst ( #108150 )
2023-08-20 19:23:28 +05:30
Erlend E. Aasland
c735e79afb
Docs: Fix Sphinx warnings in logging.rst (GH-108139)
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-20 12:19:07 +01:00
Erlend E. Aasland
4d4393139f
Docs: Fix Sphinx warnings in license.rst ( #108142 )
...
- Fix links to stdlib modules
- Silence links to external functions
2023-08-20 13:10:48 +02:00
Erlend E. Aasland
29fa7afef9
Docs: Fix Sphinx warnings in sys.rst ( #108106 )
...
- Mark up named tuple attributes as attributes
- Remove links for external functions
- io.BufferedIOBase has no 'buffer' attribute;
remove the link and mark up using :attr:`!buffer`
- (Re)format some tables as bullet lists:
- sys._emscripten_info
- sys.hash_info
- sys.int_info
- sys.thread_info
- In the paragraphs mentioning 'f_trace_lines' and 'f_trace_opcodes',
add links to the frame objects reference.
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-20 13:09:33 +02:00
Tomas R
beffb30dc7
gh-107659: Improve wording of the description of `ctypes.pointer` and `ctypes.POINTER` ( #107769 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2023-08-20 10:54:06 +00: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
Rafael Fontenelle
1dc0c58d2b
Fix misspellings in sysconfig docs ( #108156 )
2023-08-20 08:11:39 +00:00
Tin Tvrtković
a47c13cae5
gh-107980: fix doc role for asyncio.timeouts ( #108126 )
2023-08-19 13:14:38 -07:00
Erlend E. Aasland
c31c61c04e
Docs: Remove links to external C functions and macros in os.rst ( #108138 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-19 17:03:26 +00:00
Serhiy Storchaka
79db9d9a0e
gh-72684: Tkinter: provide interface for "tk busy" subcommands (GH-107684)
...
Add tkinter.Misc methods: tk_busy_hold(), tk_busy_configure(), tk_busy_cget(),
tk_busy_forget(), tk_busy_current(), and tk_busy_status().
2023-08-19 14:48:02 +03:00
Erlend E. Aasland
ca0c6c1f1e
Docs: format sys.float_info properly ( #108107 )
...
- Normalise capitalisation and punctuation
- Use attribute markup for named tuple attributes
- Use :c:macro: markup for C macros
- Use a list for the 'rounds' attribute values
- Use list-table, for better .rst readability
- Remove one unneeded sys.float_info.dig link
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-19 08:34:34 +00:00
Serhiy Storchaka
2f311437cd
gh-107704: Argument Clinic: add support for deprecating keyword use of parameters (GH-107984)
...
It is now possible to deprecate passing keyword arguments for
keyword-or-positional parameters with Argument Clinic, using the new
'/ [from X.Y]' syntax.
(To be read as "positional-only from Python version X.Y")
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-08-19 10:13:35 +03:00
C.A.M. Gerlach
eb953d6e44
gh-101100: Only show GitHub check annotations on changed doc paragraphs ( #108065 )
...
* Only show GitHub check annotations on changed doc paragraphs
* Improve check-warnings script arg parsing following Hugo's suggestions
* Factor filtering warnings by modified diffs into helper function
* Build docs on unmerged branch so warning lines match & avoid deep clone
---------
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-18 19:43:28 -05:00
Erlend E. Aasland
dd4442c8f5
gh-107801: Improve the accuracy of os.lseek docs ( #107935 )
...
- name the last parameter *whence*, like it is for seek() methods on
file objects
- add param docstrings
- structure the valid *whence* params
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-18 19:53:51 +02:00
Raymond Hettinger
6db39b1460
Minor code clean-up for the factor() recipe (GH-108114)
2023-08-18 12:13:58 -05:00
Victor Stinner
3ff5ef2ad3
gh-108014: Add Py_IsFinalizing() function ( #108032 )
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-18 12:34:41 +02:00
Erlend E. Aasland
cc58ec9724
Docs: emphasise warning and add accurate markups for sys.unraisablehook ( #108105 )
2023-08-18 12:16:22 +02:00
Erlend E. Aasland
02079b010c
gh-107801: Improve the docs of the SEEK_* constants ( #108099 )
2023-08-17 20:41:35 +00:00
Erlend E. Aasland
5c76899dad
Docs: Fix Sphinx warnings in io.rst ( #107903 )
...
- Mark up parameter and argument names properly
- If possible, link to docs for methods like `seek`, `tell`, `write`, `read`, etc.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-17 19:19:01 +00:00
Nikita Sobolev
80f30cf51b
gh-102029: Deprecate passing arguments to `_PyRLock` in `threading` ( #102071 )
2023-08-17 09:19:07 -07:00
Erlend E. Aasland
8a19f225b9
gh-107801: Document SEEK_HOLE and SEEK_DATA ( #107936 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Antoine Pitrou <antoine@python.org>
2023-08-17 16:14:01 +02:00
Adam Turner
33e6e3fec0
GH-107987: Remove the Distributing Python Modules guide ( #108016 )
2023-08-17 13:01:14 +03:00
Serhiy Storchaka
f51f0466c0
gh-107298: Fix some references in the C API documentation (GH-108072)
2023-08-17 11:16:00 +03:00
Serhiy Storchaka
c9d83f93d8
gh-107298: Add standard exceptions and warnings in the nitpick_ignore list (GH-108029)
2023-08-17 09:44:05 +03:00
Adam Turner
e88eb3775e
GH-92584: Remove references to Distutils in configure.rst ( #108043 )
...
Remove references to Distutils in configure.rst
2023-08-16 23:13:05 +02:00
Adam Turner
fbb7cbc0e9
GH-92584: Remove Installing Python Modules (Distutils version) ( #108020 )
2023-08-16 21:06:56 +00:00
Adam Turner
636ca313b2
GH-92584: Remove references to Distutils in ``PYTHONUSERBASE`` ( #108040 )
...
Remove references to Distutils in ``PYTHONUSERBASE``
2023-08-16 22:43:30 +02:00
Adam Turner
902864256c
GH-92584: Redirect macOS package installation to the PPUG ( #108044 )
2023-08-16 20:42:23 +00:00
Serhiy Storchaka
882cb79afa
gh-56166: Deprecate passing confusing positional arguments in re functions ( #107778 )
...
Deprecate passing optional arguments maxsplit, count and flags in
module-level functions re.split(), re.sub() and re.subn() as positional.
They should only be passed by keyword.
2023-08-16 13:35:35 -07:00
Adam Turner
57fcf96e4f
GH-92584: Remove reference to Distutils in ``cx_Freeze``'s description ( #108047 )
...
Remove reference to Distutils in ``cx_Freeze``'s description
2023-08-16 22:23:12 +02:00
Victor Stinner
c2941cba7a
gh-107298: Fix C API Buffer documentation ( #108011 )
2023-08-16 18:24:46 +02:00
Adam Turner
f2a9dfdee9
GH-92584: Drop reference to Distutils in ``site.USER_BASE`` ( #108031 )
...
Drop reference to Distutils in ``site.USER_BASE``
2023-08-16 18:10:44 +02:00
Victor Stinner
e35c722d22
gh-106659: Fix test_embed.test_forced_io_encoding() on Windows ( #108010 )
...
Use config.legacy_windows_stdio=1 to avoid _io._WindowsConsoleIO.
2023-08-16 11:56:56 +00:00
Erlend E. Aasland
13c36dc9ae
gh-93057: Deprecate positional use of optional sqlite3.connect() params ( #107948 )
2023-08-15 08:09:56 +00:00
Romuald Brunet
a482e5bf00
gh-76913: Add "merge extras" feature to LoggerAdapter (GH-107292)
2023-08-15 08:23:54 +01:00
Vinay Sajip
cc2cf85d03
gh-107877: Update logging levels reference table with usage criteria. ( #107894 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-08-13 14:19:41 +01:00
Raymond Hettinger
2b6dc2accc
Add another example to the statistics docs (GH-107904)
2023-08-13 08:01:23 -05:00
wookie184
2e1f688fe0
gh-107891: Fix typo in 3.12 whatsnew ( #107892 )
2023-08-12 12:05:22 +00:00
Carl Meyer
66e4edd734
gh-91051: fix segfault when using all 8 type watchers ( #107853 )
2023-08-11 12:42:26 -06:00
Erlend E. Aasland
637f7ff2c6
Docs: Document PyBUF_MAX_NDIM ( #107865 )
2023-08-11 18:03:53 +02:00
shailshouryya
23a6db98f2
gh-107421: Clarify `OrderedDict` Examples and Recipes ( #107613 )
2023-08-10 23:43:13 -05:00
Brandt Bucher
a9caf9cf90
GH-105848: Simplify the arrangement of CALL's stack (GH-107788)
2023-08-09 18:19:39 +00:00
Erlend E. Aasland
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
Erlend E. Aasland
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
Raymond Hettinger
aab6f7173a
GH-100425: Note improved commutativity in sum(). (GH-107785)
2023-08-08 18:30:33 +01:00
Erlend E. Aasland
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
Eric Snow
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
Erlend E. Aasland
8c9af6b9a0
Docs: Fix more Sphinx annotations in ctypes.rst ( #107708 )
2023-08-07 15:11:05 +02:00
Erlend E. Aasland
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
Tomas R
6925c578a0
gh-107442: Document all valid types for ctypes _as_parameter_ ( #107443 )
2023-08-07 12:41:39 +02:00
Erlend E. Aasland
a6675b1a59
Docs: Argument Clinic: Move the CConverter class to the reference ( #107671 )
2023-08-07 02:08:34 +02:00
Kamil Turek
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
Adam Turner
9564e31cbc
Do not use deprecated ``logger.warn()`` in pyspecific ( #107694 )
2023-08-06 13:58:00 +00:00
Hugo van Kemenade
9641c4d8e2
Docs: skip python-docs-theme 2023.7 to fix mobile menu ( #107666 )
2023-08-06 13:08:32 +02:00
Erlend E. Aasland
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
cocoatomo
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
Erlend E. Aasland
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
Terry Jan Reedy
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
Daniele Procida
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
Barney Gale
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
Hugo van Kemenade
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
Tomas R
09a8cc7984
gh-107600: Docs: Update ctypes.ArgumentError error message ( #107601 )
2023-08-04 16:34:04 +02:00
Hugo van Kemenade
19f32b24b2
Docs: upgrade to python-docs-theme 2023.7 ( #107617 )
2023-08-04 14:16:10 +00:00
Mark Shannon
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
Irit Katriel
dd693d6320
gh-105481: simplify definition of pseudo ops in Lib/opcode.py ( #107561 )
2023-08-02 18:16:57 +01:00
Alexandru Mărășteanu
c8872f4285
Clarify `Self` interaction with subclasses ( #107511 )
2023-08-01 13:20:25 -07:00
Irit Katriel
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
Eric Snow
79e479c45f
gh-99113: Add a What's New Entry for PEP 684 (gh-107520)
2023-07-31 23:13:55 +00:00
Eric Snow
db361a340a
gh-105766: Document that Custom Allocators Must Be Thread-Safe (gh-107519)
2023-07-31 23:11:15 +00:00
Eric Snow
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
Erlend E. Aasland
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
Jacob Walls
de51dede5b
gh-106762: Add news for `EnumMeta.__getattr__` removal (GH-107466)
2023-07-31 10:24:44 -07:00
Michael The
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
Michael The
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
Ned Deily
83e0976f89
gh-99079: Update macOS installer to use OpenSSL 3.0.9. (GH-107474)
2023-07-31 05:58:35 +00:00
Dong-hee Na
a24e25d74b
gh-107427: Update the description of UNPACK_SEQUENCE (gh-107429)
2023-07-31 00:40:37 +09:00
da-woods
f2abeb590d
Fix the documentation for PyCode_New add `qualname` parameter ( #107186 )
2023-07-29 23:11:40 +05:30
Rakesh Sabale
89fd4f4a3f
gh-107422: Remove outdated `TypedDict` example from typing docs ( #107436 )
2023-07-29 17:04:46 +00:00
Inada Naoki
37551c9cef
gh-107369: optimize textwrap.indent() ( #107374 )
2023-07-29 06:37:23 +00:00
Serhiy Storchaka
f2d07d3289
gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386)
2023-07-29 08:48:10 +03:00
Serhiy Storchaka
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
Eric Snow
cf63df88d3
gh-107307: Update the importlib Docs for PEP 684 (gh-107400)
2023-07-28 16:00:03 -06:00
Eric Snow
c0b81c4b54
gh-107305: Update the C-API Docs for PEP 684 (gh-107324)
2023-07-28 13:46:55 -06:00
Mark Shannon
1ee605c588
GH-101291: Add warning to "what's new" that `PyLongObject` internals have changed. (GH-107388)
2023-07-28 17:07:33 +01:00
Serhiy Storchaka
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
Serhiy Storchaka
983305268e
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
Victor Stinner
9a7204b86b
gh-105268: _PyGC_FINALIZED() removal is already documented in 3.12 ( #107350 )
2023-07-27 14:43:09 +00:00
Alex Waygood
f84d77b4e0
Bump some docs dependencies to resolve a Dependabot security alert ( #107341 )
2023-07-27 11:53:21 +00:00
Daniele Procida
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
Serhiy Storchaka
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
Serhiy Storchaka
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
Victor Stinner
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
Victor Stinner
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
Erlend E. Aasland
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
Erlend E. Aasland
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
Serhiy Storchaka
6d5b6e71c8
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +03:00
Serhiy Storchaka
af61cb9c78
gh-107091: Fix some uses of :c:member: role (GH-107129)
2023-07-26 22:16:06 +03:00
Roman Yurchak
737d1da074
Document that `os.link()` is not available on Emscripten (GH-104822)
2023-07-26 11:38:59 -07:00
Victor Stinner
87b39028e5
gh-107298: Fix doc references to undocumented modules ( #107300 )
...
Update also Doc/tools/.nitignore.
2023-07-26 18:59:06 +02:00
Victor Stinner
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
Pablo Galindo Salgado
da8f87b7ea
gh-107015: Remove async_hacks from the tokenizer ( #107018 )
2023-07-26 16:34:15 +01:00
Gregory P. Smith
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
Daniele Procida
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
Serhiy Storchaka
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
Erlend E. Aasland
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
da-woods
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
Hakan Celik
ebe44a5155
Docs: Remove duplicate word in Argument Clinic howto heading ( #107169 )
2023-07-24 13:54:39 +02:00
TommyUnreal
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
cLupus
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
Erlend E. Aasland
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
Ezio Melotti
956b3de816
Remove superflous whitespaces in `layout.html`. (GH-107067)
2023-07-23 17:18:50 +02:00
Dong-hee Na
d1b839b453
gh-107122: Update what's news for dbm.*dbm.clear() method (gh-107135)
2023-07-24 00:08:50 +09:00
Dong-hee Na
0ae4870d09
gh-107122: Add clear method to dbm.ndbm module (gh-107126)
2023-07-23 14:26:23 +00:00
Dong-hee Na
b273837fea
gh-107122: Add clear method to dbm.gdbm.module (gh-107127)
2023-07-23 13:51:12 +00:00
TommyUnreal
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
Serhiy Storchaka
08a228da05
gh-107091: Fix the use of some C domain roles ( #107092 )
2023-07-23 12:27:05 +02:00
Daniele Procida
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
littlebutt's workshop
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
wulmer
f5147c0cfb
gh-101100: Fix some broken sphinx references ( #107095 )
2023-07-23 03:23:44 -06:00
Tomas R
dcd7acb04a
gh-54738: Add argparse i18n howto ( #104562 )
2023-07-23 11:10:38 +02:00
wulmer
680f3e1591
gh-71261: Add paragraph on shadowing submodules with star imports ( #107004 )
2023-07-23 03:00:42 -06:00
Jakub Červinka
9629d4442e
gh-107017: removed mention that C does it the same way ( #107020 )
2023-07-23 02:57:52 -06:00
wulmer
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
Jochem Boersma
5e5a34ac3a
gh-107028: tiny textual changes in logging docs and docstrings (GH-107029)
2023-07-22 21:43:18 +01:00
Serhiy Storchaka
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
Serhiy Storchaka
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
Matthieu Caneill
6e5f2235f3
gh-83006: Document behavior of `shutil.disk_usage` for non-mounted filesystems on Unix ( #107031 )
2023-07-22 17:58:06 +02:00
wulmer
149748ea4f
Fix Sphinx warnings in `re` module docs ( #107044 )
2023-07-22 16:44:44 +01:00
Oliver Rew
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
Jocelyn Castellano
e5252c6127
gh-105090: Replace incorrect TLSv1.2 with TLSv1.3 ( #105404 )
2023-07-22 14:29:08 +00:00
Victor Stinner
756add081e
gh-106320: Document private C API removal in What's New 3.13 ( #107027 )
2023-07-22 15:30:13 +02:00
Joe Kaufeld
ed491d9f78
Reformat code block to make it easier to read ( #106965 )
2023-07-22 14:19:30 +02:00
Sebastiaan Zeeff
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
Daniele Procida
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
littlebutt's workshop
443d9b3033
gh-106976:alphabetise bullets by module name task1 ( #106982 )
2023-07-22 10:34:48 +02:00
Sebastiaan Zeeff
d55b4da10c
gh-106973: Change non-integral to non-integer in "3.12 What's New" ( #106984 )
2023-07-22 02:27:48 -06:00
Hugo van Kemenade
806d7c98a5
gh-101100: Docs: Check Sphinx warnings and fail if improved ( #106460 )
2023-07-22 08:12:43 +00:00
Victor Stinner
41ca164551
gh-106004: Add PyDict_GetItemRef() function ( #106005 )
...
* Add PyDict_GetItemRef() and PyDict_GetItemStringRef() functions.
Add these functions to the stable ABI version 3.13.
* Add unit tests on the PyDict C API in test_capi.
2023-07-21 23:10:51 +02:00
qqwqqw689
fd84ac0ee0
gh-106847: Add -X warn_default_encoding in sys.flags Doc ( #106854 )
...
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-07-21 15:47:58 +05:30
Serhiy Storchaka
4b9948617f
gh-106909: Use role :const: for referencing module constants (GH-106910)
2023-07-21 12:40:37 +03:00
Serhiy Storchaka
d036db728e
gh-106892: Use roles :data: and :const: for referencing module variables (GH-106894)
2023-07-21 12:34:30 +03:00
Serhiy Storchaka
fcc816dbff
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
Erlend E. Aasland
81861fd90b
Docs: Argument Clinic: Add Background and Tutorial top-level sections ( #106904 )
...
Add Background as a toplevel section with the following subsections:
- Background
- The goals of Argument Clinic
- Basic concepts and usage
Rename "Converting your first function" to Tutorial.
Add anchors for Background, Tutorial, and How-to Guides:
- :ref:`clinic-background`
- :ref:`clinic-tutorial`
- :ref:`clinic-howtos`
Link to these from within the Abstract.
Break the compatibility paragraph out of Abstract and make it a note.
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-07-21 08:05:41 +02:00
Gregory P. Smith
a31dea1feb
gh-106669: Revert "gh-102988: Detect email address parsing errors ... ( #105127 )" ( #106733 )
...
This reverts commit 18dfbd0357
.
Adds a regression test from the issue.
See https://github.com/python/cpython/issues/106669 .
2023-07-20 20:30:52 -07:00