24facd60f6
gh-101100: Use list of 'dirty' docs, with warnings, instead of a clean list ( #103191 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-04-03 21:59:47 +03:00
2a721258a1
gh-101865: Deprecate `co_lnotab` from code objects as per PEP 626 ( #101866 )
...
Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-04-03 17:35:04 +02:00
55decb72c4
gh-102994: Profile docs has typo in example ( #103074 )
2023-04-02 15:44:16 -07:00
32937d6aa4
gh-103109: Document ignore_warnings() test support helper ( #103110 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-03 00:18:25 +02:00
6883007a86
bpo-4080: unittest durations ( #12271 )
2023-04-03 00:12:51 +02:00
6d59c9e32e
gh-102433: Use `inspect.getattr_static` in `typing._ProtocolMeta.__instancecheck__` ( #103034 )
2023-04-02 14:22:19 +01:00
06249ec89f
gh-102192: deprecate _PyErr_ChainExceptions ( #102935 )
2023-04-01 21:30:23 +01:00
b0422e140d
gh-102871: Remove obsolete browsers from webbrowser ( #102872 )
2023-03-31 11:02:47 -04:00
048d6243d4
GH-84783: Mention Author for GH-101264 (make slices hashable) ( #103146 )
...
Will Bradshaw contributed original patch on bpo-40603.
---------
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-03-31 09:54:17 -04:00
f6405a4662
Quote literal tokens in standard format specifier grammar (GH-102902)
...
Reported by Damian Dureck: https://mail.python.org/archives/list/docs@python.org/thread/UZTWBJIXC3MBKTHXVTIBPGDPKBNWZ5LN/
2023-03-31 14:40:38 +02:00
20c0f196ff
gh-101100: Expand list of clean docs (GH-103135)
...
Follow on from https://github.com/python/cpython/pull/103116 .
Expand list of clean docs files from 3 to 181. These files have no Sphinx warnings, and their presence in this list means that any new warnings introduced will fail the build.
The list was created by subtracting the list of files with warnings from a list of all files.
I tested with all of those, but found that `touch`ing two clean files (https://github.com/python/cpython/blob/main/Doc/includes/wasm-notavail.rst and https://github.com/python/cpython/blob/main/Doc/whatsnew/changelog.rst ) caused a cascade effect and resulted in a number of dirty files being rebuilt too, and failing the build. So those two have been omitted.
Automerge-Triggered-By: GH:hugovk
2023-03-31 03:48:46 -07:00
c1e71ce56f
Minor docs improvements fix for `codeop` ( #103123 )
2023-03-30 15:51:36 -07:00
f192a558f5
gh-101100: Fix Sphinx warning in gc.rst and refactor docs clean list ( #103116 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-30 21:03:50 +03:00
fda95aa194
gh-103099: Link mypy docs from typing.rst ( #103100 )
2023-03-30 01:32:09 -07:00
d835b3f05d
gh-102582: Fix invalid JSON in Doc/howto/logging-cookbook.rst (GH-102635)
2023-03-29 09:52:53 +01:00
027223db96
Update pdb docs for arguments ( #102965 )
2023-03-25 14:31:45 -07:00
0708437ad0
gh-103025: fix two ctypes doc issues ( #103026 )
2023-03-25 09:12:00 +00:00
64cb1a4f0f
gh-100131: Add optional delete parameter to tempfile.TemporaryDirectory() ( #100132 )
...
Add optional delete parameter to tempfile.TemporaryDirectory().
Co-authored-by: Gregory P. Smith <greg@krypto.org>
2023-03-24 14:52:06 -07:00
f2e5a6ee62
gh-102873: logging.LogRecord docs: improve description of `msg` parameter ( #102875 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-24 15:00:32 +00:00
6a1c49a717
gh-101100: Test docs in nit-picky mode ( #102513 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2023-03-24 13:23:35 +02:00
413b7db8a4
gh-94684: uuid: support bytes in the name argument to uuid3/5 ( #94709 )
...
RFC 4122 does not specify that name should be a string, so for completness the functions should also support a name given as a raw byte sequence.
2023-03-23 17:42:43 -06:00
0444ae2487
GH-100982: Break up COMPARE_AND_BRANCH (GH-102801)
2023-03-23 15:25:09 -07:00
16f6165b71
Minor readability improvement to the factor() recipe (GH-102971)
2023-03-23 14:46:15 -05:00
b6132085ca
gh-98239: Document that `inspect.getsource()` can raise `TypeError` ( #101689 )
2023-03-23 19:35:02 +00:00
58d2b30c01
gh-102936: typing: document performance pitfalls of protocols decorated with `@runtime_checkable` ( #102937 )
2023-03-23 18:18:53 +00:00
4695709143
Move binomialvariate() to a section for discrete distributions (GH-102955)
2023-03-23 12:10:12 -05:00
f13fdacadf
gh-102810 Improve the sphinx docs for `asyncio.Timeout` ( #102934 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-23 16:43:13 +00:00
08254be6c5
Docs: fixup incorrect escape char in sqlite3 docs ( #102945 )
2023-03-23 14:21:32 +01:00
8709697292
[doc] Fix error in tutorial example: type(exc) is the type rather than the instance ( #102751 )
2023-03-22 18:43:41 +00:00
9b19d3936d
gh-102921: [doc] Clarify `exc` argument name in `BaseExceptionGroup` is plural ( #102922 )
2023-03-22 18:14:05 +00:00
3468c768ce
gh-102859: Remove JUMP_IF_FALSE_OR_POP and JUMP_IF_TRUE_OR_POP ( #102870 )
2023-03-22 18:10:48 +00:00
04adf2df39
gh-102780: Fix uncancel() call in asyncio timeouts ( #102815 )
...
Also use `raise TimeOut from <CancelledError instance>` so that the CancelledError is set
in the `__cause__` field rather than in the `__context__` field.
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-22 10:52:10 -07:00
af9c34f6ef
gh-96931: Fix incorrect results in ssl.SSLSocket.shared_ciphers ( #96932 )
2023-03-22 15:08:41 +01:00
7b2d53dacc
Docs: improve accuracy of sqlite3.Connection.interrupt() ( #102904 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-22 12:50:00 +01:00
c24f1f1e87
Docs: improve the accuracy of the sqlite3.connect() timeout param ( #102900 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-22 12:37:13 +01:00
e0c63b7267
Docs: improve accuracy of pdb alias example ( #102892 )
2023-03-22 12:34:52 +01:00
41ef502d74
Add link to `sys.exit` function documentation ( #102805 )
...
* Add link to `sys.exit` function documentation
* Update Doc/library/os.rst
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* Update Doc/library/os.rst
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
---------
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-22 06:58:31 +09:00
0214c7ad90
Tweak polynomial itertool recipes (GH-102880)
2023-03-21 13:21:57 -05:00
4bb1dd3c5c
gh-102876: remove superfluous parens from itertools.batched recipe (GH-102877)
...
remove superfluous parens from itertools.batched recipe
2023-03-21 12:06:18 -05:00
910a64e301
gh-102595: Document `PyObject_Format` c-api function (GH-102596)
...
Def: 5ffdaf748d/Include/abstract.h (L389)
2023-03-21 09:46:24 -07:00
7f760c2fca
gh-102828: emit deprecation warning for onerror arg to shutil.rmtree ( #102850 )
2023-03-21 11:08:46 +00:00
1a5a14183e
The pow() variant further improves accuracy (GH-102866)
2023-03-21 00:02:14 -05:00
4075fe1d8d
Remove itermediate list. Expand docstring. (GH-102862)
2023-03-20 20:40:04 -05:00
094cf392f4
Add itertool recipe for polynomial evaluation. (GH-102852)
2023-03-20 17:14:29 -05:00
28d369e070
gh-102304: Add a What's New Entry About _Py_RefTotal (gh-102845)
...
https://github.com/python/cpython/issues/102304
2023-03-20 10:35:49 -06:00
5e6661bce9
gh-72346: Added isdst deprecation warning to email.utils.localtime (GH-91450)
2023-03-19 19:20:20 -05:00
d51a6dc28e
gh-102828: add onexc arg to shutil.rmtree. Deprecate onerror. ( #102829 )
2023-03-19 18:33:51 +00:00
e1e9bab006
gh-102778: Add sys.last_exc, deprecate sys.last_type, sys.last_value,sys.last_traceback ( #102779 )
2023-03-18 11:47:11 +00:00
4f5774f648
GH-78530: add support for generators in `asyncio.wait` ( #102761 )
2023-03-17 06:58:43 +05:30
3f9285a8c5
gh-102755: Add PyErr_DisplayException(exc) ( #102756 )
2023-03-16 22:18:04 +00:00
405739f916
Fix outdated note about 'int' rounding or truncating ( #102736 )
2023-03-16 20:34:42 +00:00
0f175766e2
gh-99726: Improves correctness of stat results for Windows, and uses faster API when available (GH-102149)
...
This deprecates `st_ctime` fields on Windows, with the intent to change them to contain the correct value in 3.14. For now, they should keep returning the creation time as they always have.
2023-03-16 17:27:21 +00:00
adaed17341
GH-102748: remove legacy support for generator based coroutines from `asyncio.iscoroutine` ( #102749 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-16 20:28:10 +05:30
b0ec6253c9
GH-102653: Make recipe docstring show the correct distribution ( #102742 )
2023-03-16 09:32:18 -05:00
61b9ff35cb
gh-101100: Documenting --prefix and --exec-prefix. (GH-102695)
...
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-03-15 16:10:03 +01:00
8647ba4b63
Remove misformatted exclamation marks in docs ( #102694 )
...
Remove the exclamation mark from :program:`!foo` in .rst files because
it inadvertently shows up in the rendered HTML.
(Sphinx's cross-referencing roles use a '!' prefix to suppress
hyperlinking[1], but :program: is not a cross-referencing role so the
'!' is displayed verbatim.)
The exclamation marks in venv.rst were introduced in #98350 . See
comments [2] and [3] for additional discussion.
[1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-syntax
[2]: https://github.com/python/cpython/pull/98350#issuecomment-1285965759
[3]: https://github.com/python/cpython/pull/98350#issuecomment-1286394047
Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-03-15 09:06:32 +02:00
0a539b5db3
gh-102703: Fix typo in modules tutorial documentation (GH-102707)
...
**Before**
This prevents directories with a common name, such as ``string``, unintentionally hiding ...
**After**
This prevents directories with a common name, such as ``string``, from unintentionally hiding ...
2023-03-14 17:03:43 -07:00
152292b98f
gh-101578: mention in what's new in 3.12 that exceptions are now normalized before stored ( #102702 )
2023-03-14 22:38:15 +00:00
80abd62647
gh-102354: change python3 to python in docs examples ( #102696 )
2023-03-14 12:40:12 -06:00
88c262c086
gh-100315: clarification to `__slots__` docs. ( #102621 )
...
refer to tp_itemsize in discussion on "variable-length" built-in types
2023-03-14 09:23:52 +00:00
7bdb331b67
doc: Remove a duplicate 'versionchanged' in library/asyncio-task (gh-102677)
2023-03-14 11:07:59 +09:00
cbd3fbfb6e
gh-102013: Add PyUnstable_GC_VisitObjects ( #102014 )
2023-03-14 01:35:54 +00:00
61479d4684
gh-102627: Replace address pointing toward malicious web page ( #102630 )
...
* Replace known bad address pointing toward a malicious web page.
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-03-13 15:35:37 -07:00
78e4e6c3d7
gh-101100: Fix Sphinx warnings in `turtle` module ( #102340 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-13 11:24:52 +02:00
f6ca71a422
Fix duplicated words in the docs (GH-102629)
...
With grep utility found some duplicated words
Automerge-Triggered-By: GH:AlexWaygood
2023-03-12 11:03:59 -07:00
e6210621be
Fixes duplicated word ( #102623 )
...
In line 1627, the end of the sentence reads "only that that it may be." but it should read "only that it may be" (or alternatively "only that that may be").
Co-authored-by: Hugo Gabriel Eyherabide <hugogabriel.eyherabide@gmail.com>
2023-03-12 09:58:02 -07:00
ced13c96a4
gh-79940: add introspection API for asynchronous generators to `inspect` module ( #11590 )
2023-03-11 18:49:40 +05:30
08b67fb34f
GH-90997: Shrink the LOAD_GLOBAL caches ( #102569 )
2023-03-10 17:01:16 -08:00
b48be8fa18
gh-102103: add `module` argument to `dataclasses.make_dataclass` ( #102104 )
2023-03-10 17:26:46 -07:00
12226bec25
gh-102519: Add doc updates for os.listdrives, listvolumes and listmounts (GH-102585)
2023-03-10 15:41:32 +00:00
53dceb53ad
gh-86509: Add link to Lib/_threading_local.py in threading docs ( #101824 )
2023-03-10 13:22:02 +01:00
cb35882773
gh-102519: Add os.listdrives, os.listvolumes and os.listmounts on Windows (GH-102544)
2023-03-10 12:21:37 +00:00
58d761e5b5
GH-84783: Document GH-101264 (Make the slice object hashable) in What's New. ( #102548 )
2023-03-08 18:39:33 -08:00
7d801f245e
Remove or update bitbucket links (GH-101963)
...
Since Mercurial removal from bitbucket.org, some links are broken.
They are replaced by github.com or webarchive.org links if available. Otherwise, they are removed.
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-03-08 11:24:39 +01:00
1f557f94c2
gh-101100: Fix sphinx warnings in `zipapp` and `zipfile` modules ( #102526 )
2023-03-08 08:19:05 +00:00
061325e0d2
Fix style in argparse.rst ( #101733 )
2023-03-07 23:25:28 -08:00
1e703a4733
gh-102381: don't call watcher callback with dead object ( #102382 )
...
Co-authored-by: T. Wouters <thomas@python.org>
2023-03-07 17:10:58 -07:00
4a3ea1fdd8
gh-95913: Consolidate build requirements changes in 3.11 WhatsNew (GH-98781)
...
Apply suggestion to combine build requirements changes in 3.11 WhatsNew
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2023-03-07 15:38:31 +01:00
80b19a30c0
gh-95913: Edit Faster CPython section in 3.11 WhatsNew (GH-98429)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-07 10:45:52 +08:00
d959bcd4a0
Add gettext support to tools/extensions/c_annotations.py ( #101989 )
2023-03-06 23:20:52 +02:00
d3ca042c99
gh-95672: Fix versionadded indentation of get_pagesize in test.rst (gh-102455)
2023-03-06 22:56:19 +09:00
6716254e71
GH-101362: Optimise PurePath(PurePath(...)) (GH-101667)
...
The previous `_parse_args()` method pulled the `_parts` out of any supplied `PurePath` objects; these were subsequently joined in `_from_parts()` using `os.path.join()`. This is actually a slower form of joining than calling `fspath()` on the path object, because it doesn't take advantage of the fact that the contents of `_parts` is normalized!
This reduces the time taken to run `PurePath("foo", "bar")` by ~20%, and the time taken to run `PurePath(p, "cheese")`, where `p = PurePath("/foo", "bar", "baz")`, by ~40%.
Automerge-Triggered-By: GH:AlexWaygood
2023-03-05 15:50:21 -08:00
5da379ca7d
Move around example in to_bytes() to avoid confusion ( #101595 )
...
Moves an example to be closer to the sentence that refers to it.
2023-03-05 09:31:56 +00:00
eff9f43924
gh-96821: Add config option `--with-strict-overflow` ( #96823 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Shantanu <hauntsaninja@gmail.com>
2023-03-04 13:39:52 -08:00
cb944d0be8
Add import of `unittest.mock.Mock` in documentation ( #102346 )
2023-03-03 22:55:31 +05:30
7b9132057d
gh-102383: [docs] Arguments of `PyObject_CopyData` are `PyObject *` ( #102390 )
2023-03-03 22:46:50 +05:30
4e7c0cbf59
gh-101754: Document that Windows converts keys in `os.environ` to uppercase (GH-101840)
2023-03-03 10:51:32 +00:00
73250000ac
Fix typos in documentation and comments (GH-102374)
...
Found some duplicate `to`s in the documentation and some code comments and fixed them.
[Misc/NEWS.d/3.12.0a1.rst](ed55c69ebd/Misc/NEWS.d/3.12.0a1.rst
2023-03-02 07:26:49 -08:00
eaae563b68
gh-102088 Optimize iter_index itertools recipe (GH-102360)
2023-03-01 21:16:23 -06:00
2f62a5da94
gh-95672 skip fcntl when pipesize is smaller than pagesize (gh-102163)
2023-03-01 23:56:19 +09:00
7d1d663418
Doc: Fix minor error in ePub (GH-100614)
...
Fix issue reported https://mail.python.org/archives/list/docs@python.org/message/KE7OIAO53P4XRC4ZOWPDHA63ZQJCHEC3/
2023-03-01 09:48:15 +09:00
85b1fc1fc5
GH-90744: Fix erroneous doc links in the sys module ( #101319 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-02-28 13:43:00 +02:00
6b2d7c0ddb
gh-101101: Unstable C API tier (PEP 689) (GH-101102)
2023-02-28 09:31:01 +01:00
0f89acf6cc
gh-101561: Add typing.override decorator ( #101564 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-02-27 13:16:11 -08:00
4624987b29
gh-101825: Clarify that as_integer_ratio() output is always normalized ( #101843 )
...
Make docstrings for `as_integer_ratio` consistent across types, and document that
the returned pair is always normalized (coprime integers, with positive denominator).
---------
Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
2023-02-27 19:11:28 +00:00
0db6f44259
gh-102296 Document that inspect.Parameter kinds support ordering (GH-102297)
...
Automerge-Triggered-By: GH:AlexWaygood
2023-02-27 07:13:18 -08:00
101a12c576
gh-101100: Fix sphinx warnings in `types` module ( #102274 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-02-27 07:26:21 +00:00
f3cb15c88a
gh-91038: Change default argument value to `False` instead of `0` ( #31621 )
...
The argument is used as a switch and corresponds to a boolean logic. Therefore it is more intuitive to use the corresponding constant `False` as default value instead of the integer `0`.
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-02-26 18:10:34 -08:00
6daf42b28e
[doc] Improve grammar/fix missing word (GH-102060)
2023-02-26 18:45:27 +05:30
bcadcde712
gh-102259: Fix re doc issue regarding right square brackets ( #102264 )
...
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-02-25 21:22:16 -05:00
Hugo van Kemenade
Nikita Sobolev
Nouran Ali
Charlie Zhao
Giampaolo Rodola
Alex Waygood
Irit Katriel
James De Bias
Furkan Onder
Petr Viktorin
gaogaotiantian
Shantanu
Matěj Cepl
Peter Jiping Xie
JakobDev
Amin Alaee
MonadChains
Brandt Bucher
Raymond Hettinger
JosephSBoyle
Erlend E. Aasland
Jens-Hilmar Bradt
Kevin Kirsche
Kristján Valur Jónsson
Benjamin Fogle
David Poirier
wim glenn
Eric Snow
Alan Williams
Kumar Aditya
Mark Dickinson
Steve Dower
Julien Palard
Tom Levy
Robert Prater (B. Eng)
Paul Watson
T
Joongi Kim
Jacob Bower
Blind4Basics
Виталий Дмитриев
Guido van Rossum
Thomas Krennwallner
Owain Davies
T. Wouters
sblondon
Marcin Wieczorek
Carl Meyer
C.A.M. Gerlach
Rémi Lapeyre
Hyunkyun Moon
Barney Gale
Sergey B Kirpichev
Matthias Görgens
Wagner Alberto
Michael K
Stefan Pochmann
Inada Naoki
Steven Troxler
Gouvernathor
Rotzbua
VMan
Skip Montanaro