kato8966
38ab0dba80
Fix typo in multiprocessing docs ( #108666 )
2023-08-30 12:05:29 +01:00
Sebastian Rittau
6c484c39be
gh-108669: unittest: Fix documentation for TestResult.collectedDurations ( #108670 )
2023-08-30 09:36:59 +00:00
sterliakov
14ec0bb7c3
Mention Ellipsis pickling in the docs ( #103660 )
2023-08-30 01:11:31 +00:00
Erlend E. Aasland
0b0c1d046c
gh-108278: Deprecate passing the first param of sqlite3.Connection callback APIs by keyword ( #108632 )
...
Deprecate passing the callback callable by keyword for the following
sqlite3.Connection APIs:
- set_authorizer(authorizer_callback)
- set_progress_handler(progress_handler, ...)
- set_trace_callback(trace_callback)
The affected parameters will become positional-only in Python 3.15.
2023-08-29 22:02:12 +02:00
Erlend E. Aasland
8178a88bd8
gh-107801: Improve the accuracy of io.IOBase.seek docs ( #108268 )
...
- Add param docstrings
- Link to os.SEEK_* constants
- Mention the return value in the initial paragraph
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-29 19:13:38 +00:00
xzmeng
88f1c5b454
Fix misc doc typos ( #108592 )
2023-08-29 00:14:21 +00:00
Matthias Bussonnier
f75cefd402
gh-106670: Allow Pdb to move between chained exceptions ( #106676 )
2023-08-28 18:31:03 +00:00
Erlend E. Aasland
4116592b6f
gh-108278: Deprecate passing the three first params as keyword args for sqlite3 UDF creation APIs ( #108281 )
...
Deprecate passing name, number of arguments, and the callable as keyword
arguments, for the following sqlite3.Connection APIs:
- create_function(name, nargs, callable, ...)
- create_aggregate(name, nargs, callable)
The affected parameters will become positional-only in Python 3.15.
2023-08-28 13:32:07 +00:00
Erlend E. Aasland
8db451ceb1
gh-64662: Fix NEWS entry and remove What's New entry ( #108565 )
2023-08-28 12:02:26 +00:00
nikkie
72b615ab01
Fix typo in typing docs: Remove redundant backtick ( #108559 )
2023-08-28 11:19:29 +00:00
Adam Turner
5d936b6479
GH-108202: Combine documentation of ``calendar`` constants ( #108492 )
2023-08-27 23:19:31 -06:00
Erlend E. Aasland
d0160c7c22
gh-64662: Add virtual table support to sqlite3.Connection.iterdump ( #108340 )
...
Co-authored-by: Aviv Palivoda <palaviv@gmail.com>
2023-08-28 00:18:32 +02:00
Erlend E. Aasland
38afa4af9b
gh-107801: Document io.TextIOWrapper.tell ( #108265 )
2023-08-27 20:35:27 +00:00
Raymond Hettinger
042aa88bcc
gh-108322: Optimize statistics.NormalDist.samples() (gh-108324)
2023-08-27 08:59:40 -05:00
Matthew James Kraai
cd0a8aece9
Fix grammatical error in stringprep documentation ( #108414 )
...
Remove the word "them", which didn't make grammatical sense.
Co-authored-by: KRAAI, MATTHEW [VISUS] <mkraai@its.jnj.com>
2023-08-27 11:26:23 +00:00
R
7096a2be33
gh-105052:update timeit function's description ( #105060 )
...
---------
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-08-27 03:22:27 -04:00
qqwqqw689
1ac64237e6
gh-107453: Document errno.{ECANCELED,EOWNERDEAD,ENOTRECOVERABLE,ENOTSUP} ( #107486 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-27 05:19:49 +00:00
denballakh
e407cea193
gh-107406: Add better `struct.Struct` repr ( #107407 )
2023-08-26 15:24:16 +05:30
Philipp A
6895ddf6cb
gh-102211: Document `re.{Pattern,Match}`’s existence ( #102212 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-08-25 10:53:11 -06:00
Erlend E. Aasland
cb1184280b
Docs: Resolve Sphinx warnings in dis.rst ( #108476 )
...
- Link to the code objects reference
- Suppress link to deliberately undocumented builtins.__build_class__
- Suppress links for example methods
2023-08-25 13:28:47 +02:00
Adam Turner
2b7bff0655
Datamodel: Add headings to the standard type hierarchy ( #108146 )
...
Dedent content according to the new layout.
2023-08-25 13:02:36 +02:00
Adam Turner
7f5b1a0661
Docs: Datamodel: Merge "Notes on using __slots__" with the parent section ( #108400 )
2023-08-25 12:27:36 +02:00
Corvin
24aa249a66
gh-107932: Fix dis module for bytecode that does not have an associated source line (GH-107988)
2023-08-25 09:31:26 +01:00
Peeyush Aggarwal
8d4052075e
gh-103384: Generalize the regex pattern `BaseConfigurator.INDEX_PATTERN` to allow spaces and non-alphanumeric characters in keys. (GH-103391)
...
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-25 09:15:26 +01:00
Adam Turner
135098743a
GH-108202: Document ``calendar`` exceptions ( #108398 )
2023-08-24 23:56:54 -06:00
Victor Stinner
be436e08b8
gh-108444: Add PyLong_AsInt() public function ( #108445 )
...
* Rename _PyLong_AsInt() to PyLong_AsInt().
* Add documentation.
* Add test.
* For now, keep _PyLong_AsInt() as an alias to PyLong_AsInt().
2023-08-24 23:55:30 +02:00
A
7f31676340
Fix a code snippet typo in asyncio docs ( #108427 )
2023-08-24 16:27:54 +00:00
Victor Stinner
6726626646
gh-108314: Add PyDict_ContainsString() function ( #108323 )
2023-08-24 15:59:12 +02:00
Daniele Procida
809ea7c4b6
gh-107432 Update Porting Python 2 Code to Python 3 how-to (GH-107434)
...
https://docs.python.org/3/howto/pyporting.html#porting-python-2-code-to-python-3 was written for another time. In this patch:
- material that frames Python 3 as "new" is removed
- descriptions and directions have been trimmed
2023-08-24 11:28:23 +02:00
Gregory P. Smith
b6be18812c
gh-70766: Mention the object getstate caveat in 3.11 What's new. ( #108379 )
2023-08-23 15:00:09 -07:00
Serhiy Storchaka
422f81b5d2
gh-107298: Fix a few more refs in the C API docs (GH-108361)
...
gh-107298: Fix few more refs in the C API docs
2023-08-23 20:12:42 +03:00
Petr Viktorin
31b61d19ab
gh-108294: Add time.sleep audit event (GH-108298)
2023-08-23 11:00:22 +02:00
FrozenBob
79fdacc005
gh-108267: Dataclasses docs: Fix object.__setattr__ typo ( #108355 )
...
Fixed a sentence in dataclasses.rst
Changed "__setattr__" to "object.__setattr__" in a section that was specifically supposed to refer to the __setattr__ method of the object class. Also suppressed the link to the data model docs for __setattr__, since we're talking about a specific __setattr__ implementation, not __setattr__ methods in general.
2023-08-23 08:11:15 +01:00
Hugo van Kemenade
fc23f34cc9
gh-107136: Remove Plausible for docs metrics ( #107856 )
2023-08-22 20:45:22 +02:00
Adam Turner
e97b7bef4f
GH-92584: Remove distutils from the newtypes tutorial includes ( #108024 )
2023-08-22 20:42:51 +02:00
Hadházy Tamás
13966da71b
gh-105857: Document that asyncio subprocess std{in,out,err} can be file handles ( #107986 )
...
stdin/out can be filehandles -> add to docs.
2023-08-22 20:41:56 +02:00
Hugo van Kemenade
39de79b345
Document 3.13, 3.14 and future removals ( #108055 )
2023-08-22 20:40:46 +02:00
Hugo van Kemenade
35cb1605d0
Docs: Add link to skip to datetime's format codes ( #108027 )
2023-08-22 20:38:38 +02:00
Nikita Sobolev
e8ef0bdd8c
gh-107700: [Enum] Document that `EnumType` was added in 3.11 (GH-108260)
2023-08-22 07:34:18 -07:00
Erlend E. Aasland
893215a4e7
Docs: align the param spec of sqlite3.Connection methods with the implementation ( #108285 )
...
- no parameters of create_aggregate() are positional-only
- all parameters of create_collation() are positional-only
2023-08-22 13:20:58 +00:00
Serhiy Storchaka
d7202e4879
gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258)
2023-08-22 15:50:30 +03:00
Junya Fukuda
c556f9a3c9
gh-106971: Docs: Add missing issue reference ( #106992 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-22 15:38:01 +03:00
Erlend E. Aasland
1a1bfc2891
gh-105539: Emit ResourceWarning if sqlite3 database is not closed explicitly ( #108015 )
2023-08-22 13:10:29 +02:00
Erlend E. Aasland
7f87ebbc3f
gh-107801: Improve the accuracy of io.TextIOWrapper.seek docs ( #107933 )
...
Clearly document the supported seek() operations:
- Rewind to the start of the stream
- Restore a previous stream position (given by tell())
- Fast-forward to the end of the stream
2023-08-22 09:37:53 +02:00
Sam Gross
4b32d4f49c
gh-108223: Document --disable-gil flag in configure ( #108236 )
2023-08-21 20:37:07 +00:00
Serhiy Storchaka
d63972e289
gh-107298: Fix C API datetime documentation (GH-108034)
2023-08-21 21:15:46 +03:00
temach
1cc391d9e2
gh-108224: Fix asyncio doc inconsistency ( #108230 )
...
(Spawning subprocesses does not require the event loop to run in the main thread -- only signal handling does.)
2023-08-21 18:08:04 +00:00
Serhiy Storchaka
db55383829
gh-107298: Fix references to deprecated and removed PyUnicode C API (GH-108077)
2023-08-21 20:05:15 +03:00
Irit Katriel
10a91d7e98
gh-108113: Make it possible to create an optimized AST ( #108154 )
2023-08-21 16:31:30 +00:00
David Lechner
47022a079e
docs: fix grammar in isolating-extensions.rst ( #108037 )
2023-08-21 15:41:34 +00:00
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