Commit Graph

13436 Commits

Author SHA1 Message Date
Rafael Fontenelle ab80c6b402
GH-103484: Fix broken links reported by linkcheck (#124169) 2024-09-17 17:05:15 +02:00
Rafael Fontenelle 33eeccf6d4
Use pep role instead of url (#121611) 2024-09-17 16:02:14 +03:00
Rafael Fontenelle 0a32c6959c
GH-103484: Fix permanently redirects reported by linkcheck (GH-124144)
Fix redirects reported by linkcheck, update docs conf.py checks.
2024-09-17 02:53:38 +00:00
Chris Barker 38809171b8
gh-121607: Edited source file import recipe to make it more clear (#121519)
Co-authored-by: Brett Cannon <brett@python.org>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2024-09-13 16:36:40 -07:00
utkonos bbb36c0934
Normalize cdecl formatting as found elsewhere on ctypes.rst (#121379) 2024-09-13 18:26:16 +03:00
Benjamin Peterson bb904e063d
closes gh-124016: update Unicode to 16.0.0 (#124017) 2024-09-13 07:47:04 -07:00
Yngve Mardal Moe 584cdf8d41
gh-123614: Add save function to turtle.py (#123617) 2024-09-12 21:36:17 -07:00
Jason R. Coombs a47cd21890
gh-123976: Refresh docs around custom providers. (#123977)
* gh-123976: Refresh docs around custom providers.

* Remove excess whitespace.
2024-09-13 02:29:08 +00:00
Nice Zombies 8e99495701
gh-118577: Clarify that inspect.BoundArguments prefers to put values in args (GH-119936) 2024-09-12 14:03:32 +02:00
sobolevn 3bd942f106
Fix "The Matrix" movie release year in `typing.rst` (#123965) 2024-09-11 21:25:23 +03:00
Hugo van Kemenade eb169f4027
Update Sphinx Lint and fix unnecessary parentheses in `:func:`s (#123960) 2024-09-11 21:05:15 +03:00
Bénédikt Tran ef05801ba0
gh-108951: Document how to terminate an asyncio.TaskGroup (#123837)
We don't want to add another API, since the recipe is straightforward and rarely needed.

The advantage is that we could backport this to the earliest Python version that has taskgroups (3.11, alas in security mode already, so we'll just do 3.12 and 3.13).
2024-09-11 08:43:24 -07:00
Jelle Zijlstra 5436d8b9c3
gh-119180: Documentation for PEP 649 and 749 (#122235)
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2024-09-11 07:49:59 -07:00
Bénédikt Tran 07f0bf5aa4
gh-123165: update docs signature for `dis.disassemble` (#123808) 2024-09-10 15:25:27 +01:00
Petr Viktorin 1b29f4144c
gh-123905: Update TOML description to include version number (GH-123906)
Update TOML description to include version number

There is some movement, currently blocked, that would update the TOML spec to 1.1.0; this would include breaking changes to what characters are allowed. Thus, it is worthwhile for the library page to be clear which version is implemented here.

Co-authored-by: Paul Hoffman <phoffman@proper.com>
2024-09-10 14:16:32 +00:00
Raymond Hettinger 2afba5ca6d
Small improvements to the itertools docs (GH-123885) 2024-09-09 20:57:49 -05:00
sobolevn b950831c94
Mention `curl` in `contextvars` docs (#123838) 2024-09-09 16:58:49 +03:00
Bénédikt Tran 32bc2d6141
gh-123834: Add `symtable` to the list of modules with a CLI (#123835) 2024-09-09 13:45:43 +02:00
Wulian beee91cdcc
gh-123789: `secrets.randbits` returns only non-negative int (#123801) 2024-09-07 21:17:59 -07:00
Wei-Hsiang (Matt) Wang 93050e4614
Remove excessive backticks in logging doc (#123813) 2024-09-07 18:09:02 +00:00
Stanislav Terliakov 56e4a417ce
gh-123523: Rework typing documentation for generators and coroutines, and link to it from `collections.abc` docs (#123544) 2024-09-06 17:41:06 +01:00
David Caron 67957ea77d
gh-103066: Add links and `help` in site.py constants (#103777)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-09-06 10:29:28 +03:00
nkinnan b5aa271f86
gh-123476: Add support for TCP_QUICKACK socket setting to Windows (#123478)
Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Steve Dower <steve.dower@microsoft.com>
2024-09-05 22:59:48 +02:00
edson duarte 9aea9c100f
gh-85453: Improve instance attributes mark up on datetime.rst (#123655)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-09-05 20:56:52 +03:00
Pieter Eendebak 327463aef1
gh-123207: Clarify the documentation for the mro lookup for super() (GH-123417) 2024-09-05 15:52:04 +02:00
Nice Zombies c530ce1e9d
gh-118710: Make IPv*Address.version & max_prefixlen available on the class (GH-120698) 2024-09-04 15:51:12 +02:00
ryan-duve c08ede2714
gh-123392: Clarify wording regarding parameters that are functions to be called (GH-123394) 2024-09-04 11:05:46 +00:00
Nice Zombies 22fdb8cf89
gh-118508: Clarify which characters are matched by `\s` (#119155)
Clarify re syntax
2024-09-02 07:48:15 -04:00
sobolevn c3ed775899
gh-123570: Add link to `weakref.ref` from `weakref_slot` docs in `dataclasses` (#123571) 2024-09-02 09:58:38 +03:00
sobolevn 75e72822a3
gh-91126: Docs and tests for slotted dataclasses with `__init_subclass__` (#123342) 2024-09-01 13:25:34 +03:00
jlallas384 bac0e115b8
gh-123550: Fix code snippet of `BUILD_TUPLE` in `dis` docs (#123551) 2024-09-01 07:11:40 +01:00
Aarni Koskela 0b6acfee04
gh-123494: Improve documentation for ``webbrowser`` return types (#123495)
Document the return value for ``webbrowser.open*()``.
2024-09-01 06:17:03 +01:00
Wei-Hsiang (Matt) Wang cf472577e2
gh-123517: Remove unnecessary ``:meth:`` parentheses (#123518) 2024-09-01 05:59:42 +01:00
Wei-Hsiang (Matt) Wang 103a0470e3
gh-123492: Remove unnecessary `:func:` parentheses (#123493) 2024-08-30 14:34:09 +03:00
Bénédikt Tran 40fff90ae3
gh-101860: document `property.__name__` (GH-123399) 2024-08-28 16:10:13 +02:00
Mark Shannon f49a91648a
GH-117759: Document incremental GC (GH-123266)
* Update what's new

* Update gc module docs and fix inconsistency in gc.get_objects
2024-08-27 15:23:39 +01:00
Barney Gale 7bd6ebf696
GH-73991: Prune `pathlib.Path.copy()` and `copy_into()` arguments (#123337)
Remove *ignore* and *on_error* arguments from `pathlib.Path.copy[_into]()`,
because these arguments are under-designed. Specifically:

- *ignore* is appropriated from `shutil.copytree()`, but it's not clear
  how it should apply when the user copies a non-directory. We've changed
  the callback signature from the `shutil` version, but I'm not confident
  the new signature is as good as it can be.
- *on_error* is a generalisation of `shutil.copytree()`'s error handling,
  which is to accumulate exceptions and raise a single `shutil.Error` at
  the end. It's not obvious which solution is better.

Additionally, this arguments may be challenging to implement in future user
subclasses of `PathBase`, which might utilise a native recursive copying
method.
2024-08-26 17:05:34 +01:00
Barney Gale 033d537cd4
GH-73991: Make `pathlib.Path.delete()` private. (#123315)
Per feedback from Paul Moore on GH-123158, it's better to defer making
`Path.delete()` public than ship it with under-designed error handling
capabilities.

We leave a remnant `_delete()` method, which is used by `move()`. Any
functionality not needed by `move()` is deleted.
2024-08-26 16:26:34 +01:00
Barney Gale c68a93c582
GH-73991: Add `pathlib.Path.copy_into()` and `move_into()` (#123314)
These two methods accept an *existing* directory path, onto which we join
the source path's base name to form the final target path.

A possible alternative implementation is to check for directories in
`copy()` and `move()` and adjust the target path, which is done in several
`shutil` functions. This behaviour is helpful in a shell context, but
less so in a stored program that explicitly specifies destinations. For
example, a user that calls `Path('foo.py').copy('bar.py')` might not
imagine that `bar.py/foo.py` would be created, but under the alternative
implementation this will happen if `bar.py` is an existing directory.
2024-08-26 14:14:23 +01:00
CF Bolz-Tereick 70bfef52b5
gh-82378: Document the difference between sys.tracebacklimit and the limit arguments (#123286) 2024-08-25 23:50:43 +01:00
Kirill Podoprigora 249b083ed8
gh-122982: Extend the deprecation period for bool inversion by two years (#123306) 2024-08-25 12:24:44 -07:00
Barney Gale 625d0705b9
GH-73991: Add `pathlib.Path.move()` (#122073)
Add a `Path.move()` method that moves a file or directory tree, and returns a new `Path` instance pointing to the target.

This method is similar to `shutil.move()`, except that it doesn't accept a *copy_function* argument, and it doesn't check whether the destination is an existing directory.
2024-08-25 16:51:51 +01:00
Adam Turner 127660bcdb
GH-109975: Copyedit 3.13 What's New: Improved Modules (#123132)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-08-24 14:32:35 +01:00
Bar Harel 90b6d0e0f8
gh-123213: Fixed xml.etree.ElementTree.Element.extend and assignment to no longer hide exceptions (GH-123214) 2024-08-23 12:12:58 +03:00
Bénédikt Tran b1d3bd2e09
gh-123165: make `dis` functions render positions on demand (#123168) 2024-08-21 14:46:24 +01:00
Pedro Lacerda be257c5815
gh-123049: configparser: Allow to create the unnamed section from scratch. (#123077)
---------

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-08-18 15:52:25 -04:00
Sergey B Kirpichev b0f462d4c8
gh-123110: correct note about _Bool in the struct module docs (GH-123111) 2024-08-18 16:58:58 +03:00
mathysEthical e9287ea426
fix typo in dis.rst (#121612) 2024-08-17 14:20:58 +05:30
Rafael Fontenelle 26de1b245e
Remove unneeded verb in the phrase in sys.rst (#122718) 2024-08-17 14:18:31 +05:30
Damien 8a59deca59
gh-122519: Adding socket module shutdown() constants description (#122543) 2024-08-17 13:59:23 +05:30