f373c6b948
gh-107208: Fix iter_index() recipe to not swallow exceptions (gh-108835)
...
gh-107208: iter_index now supports "stop" and no longer swallows ValueError
2023-09-02 22:25:13 -05:00
4f9b706c6f
gh-108794: doctest counts skipped tests ( #108795 )
...
* Add 'skipped' attribute to TestResults.
* Add 'skips' attribute to DocTestRunner.
* Rename private DocTestRunner._name2ft attribute
to DocTestRunner._stats.
* Use f-string for string formatting.
* Add some tests.
* Document DocTestRunner attributes and its API for statistics.
* Document TestResults class.
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-09-02 16:42:07 +02:00
5141b1ebe0
gh-101100: Fix sphinx warnings in `unittest.mock-examples.rst` ( #108810 )
2023-09-02 13:05:44 +01:00
dd05c2054f
Fix typo in `uuid.rst` ( #108809 )
2023-09-02 10:08:46 +00:00
21da4980f5
gh-101100: Fix sphinx warnings in `uuid.rst` ( #108805 )
...
* gh-101100: Fix sphinx warnings in `uuid.rst`
* Use anchors
2023-09-02 09:32:19 +00:00
8f9ea43ee8
gh-105563: reference DateType in datetime's documentation ( #105946 )
2023-09-01 13:36:24 -07:00
c1e2f3b2f7
`ast` docs: Fix incorrect link on `keyword` ( #108728 )
...
In two places, Sphinx was erroneously adding links to the `keyword` module instead of the `ast.keyword` class
2023-08-31 23:17:32 +01:00
991e4e76b5
gh-101100: Fix sphinx warnings in `threading.rst` ( #108684 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-31 10:28:27 +03:00
38ab0dba80
Fix typo in multiprocessing docs ( #108666 )
2023-08-30 12:05:29 +01:00
6c484c39be
gh-108669: unittest: Fix documentation for TestResult.collectedDurations ( #108670 )
2023-08-30 09:36:59 +00:00
14ec0bb7c3
Mention Ellipsis pickling in the docs ( #103660 )
2023-08-30 01:11:31 +00:00
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
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
88f1c5b454
Fix misc doc typos ( #108592 )
2023-08-29 00:14:21 +00:00
f75cefd402
gh-106670: Allow Pdb to move between chained exceptions ( #106676 )
2023-08-28 18:31:03 +00:00
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
72b615ab01
Fix typo in typing docs: Remove redundant backtick ( #108559 )
2023-08-28 11:19:29 +00:00
5d936b6479
GH-108202: Combine documentation of ``calendar`` constants ( #108492 )
2023-08-27 23:19:31 -06:00
38afa4af9b
gh-107801: Document io.TextIOWrapper.tell ( #108265 )
2023-08-27 20:35:27 +00:00
042aa88bcc
gh-108322: Optimize statistics.NormalDist.samples() (gh-108324)
2023-08-27 08:59:40 -05:00
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
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
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
e407cea193
gh-107406: Add better `struct.Struct` repr ( #107407 )
2023-08-26 15:24:16 +05:30
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
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
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
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
135098743a
GH-108202: Document ``calendar`` exceptions ( #108398 )
2023-08-24 23:56:54 -06:00
7f31676340
Fix a code snippet typo in asyncio docs ( #108427 )
2023-08-24 16:27:54 +00:00
31b61d19ab
gh-108294: Add time.sleep audit event (GH-108298)
2023-08-23 11:00:22 +02:00
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
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
35cb1605d0
Docs: Add link to skip to datetime's format codes ( #108027 )
2023-08-22 20:38:38 +02:00
e8ef0bdd8c
gh-107700: [Enum] Document that `EnumType` was added in 3.11 (GH-108260)
2023-08-22 07:34:18 -07:00
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
1a1bfc2891
gh-105539: Emit ResourceWarning if sqlite3 database is not closed explicitly ( #108015 )
2023-08-22 13:10:29 +02:00
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
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
10a91d7e98
gh-108113: Make it possible to create an optimized AST ( #108154 )
2023-08-21 16:31:30 +00:00
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
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
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
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
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
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
1dc0c58d2b
Fix misspellings in sysconfig docs ( #108156 )
2023-08-20 08:11:39 +00:00
a47c13cae5
gh-107980: fix doc role for asyncio.timeouts ( #108126 )
2023-08-19 13:14:38 -07:00
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
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
Raymond Hettinger
Victor Stinner
Nikita Sobolev
TATHAGATA ROY
Alex Povel
kato8966
Sebastian Rittau
sterliakov
Erlend E. Aasland
xzmeng
Matthias Bussonnier
nikkie
Adam Turner
Matthew James Kraai
R
qqwqqw689
denballakh
Philipp A
Corvin
Peeyush Aggarwal
A
Petr Viktorin
FrozenBob
Hadházy Tamás
Hugo van Kemenade
temach
Irit Katriel
Tomas R
Rafael Fontenelle
Tin Tvrtković