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