5a094f0255
gh-96098: Clearly link concurrent.futures from threading & multiprocessing docs (GH-96112)
...
Clearly link concurrent.futures from threading & multiprocessing docs
Also link directly to asyncio from the beginning of the threading docs.
(cherry picked from commit bcc4cb0c7d
2022-08-20 21:27:22 -07:00
442674e37e
Docs: Fix markup of module name in sqlite3 docs (GH-96115)
...
(cherry picked from commit ee9f22d346
2022-08-19 01:25:27 -07:00
d52834d5f5
Doc: Use consistent markup for example Point class in sqlite3 (GH-96095)
...
(cherry picked from commit 303ef0913e
2022-08-19 00:49:39 -07:00
8a6e651e20
Docs: group sqlite3.Connection attributes and methods (GH-96090)
...
(cherry picked from commit 1a140af40b
2022-08-19 00:38:21 -07:00
5e28ec54ff
gh-94635: Remove sqlite3 doc introduction heading (GH-96089)
...
(cherry picked from commit ede771cdf9
2022-08-19 00:28:49 -07:00
eb182fe9eb
[3.10] Docs: Escape lone stars in sqlite3 docs (GH-96081). ( #96085 )
...
(cherry picked from commit 91afe66707
2022-08-18 22:27:51 +02:00
882dd9fe0d
gh-95271: Rework sqlite3 tutorial (GH-95749)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit c87ea10fc9
2022-08-18 11:44:58 -07:00
a372a7d653
gh-94439: typing docs: Add minimum version to `__required_keys__` and `__optional_keys__` (GH-95373)
...
(cherry picked from commit f235178bec
2022-08-12 21:31:51 -07:00
44bf05ed0c
gh-82180: Document support for non-integer arg removed from grp.getgrgid in 3.10 (GH-95346) (GH-95930)
...
(cherry picked from commit 50bf5fafcc
2022-08-12 19:03:37 +02:00
e21574a823
gh-92412: Clarify the documentation on library/syslog (GH-92587) (GH-95266)
...
(cherry picked from commit b7ce4625fe
2022-08-12 18:19:08 +02:00
75299dcab5
[3.10] gh-95273: Improve sqlite3.complete_statement docs (GH-95840) ( #95918 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit e6623e7083
2022-08-12 09:37:45 +02:00
759227f7e9
gh-75510: Edit idlelib entry in doc (GH-95869)
...
Make section instead of subsection and revise sentence.
(cherry picked from commit 9af4aed73a
2022-08-10 20:03:01 -07:00
346aa78af4
Fix documentation typo for functools.cmp_to_key (GH-95766) ( #95777 )
2022-08-10 00:40:15 -05:00
64abb73354
gh-75500: Add idlelib section to IDLE doc (GH-95832)
...
This enables accessing IDLE as 'idlelib' in the Doc Module listing.
(cherry picked from commit 70fc9641b5
2022-08-09 12:33:37 -07:00
d57d86a591
gh-95767: Fix grammatical error in asyncio loop.create_task docs (GH-95768)
...
(cherry picked from commit 141f2517fc
2022-08-09 07:07:21 -07:00
49e505c4bd
[3.10] gh-95273: Reorganize sqlite3 doc module level funcs and vars (GH-95626) ( #95803 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 41c939cb35
2022-08-08 22:08:43 +02:00
255f7ded77
gh-94635: Fixup sqlite3 'Introduction' seealso note (GH-95751)
...
In gh-95269, the seealso note incorrectly ended up in
the 'Tutorial' section.
(cherry picked from commit 56af5a200d
2022-08-06 14:38:18 -07:00
7c711aecf6
gh-89362: Doc IDLE menu and search (GH-95697)
...
Update menu item position and capitalization.
Add paragraph about search.
For help.html, include save-as addition.
(cherry picked from commit 834064c19a
2022-08-05 09:51:53 -07:00
57446f9e33
bpo-42037: Corrected request dependencies in CookieJar functions (GH-23112) (GH-95515)
...
(cherry picked from commit d29e279de3
2022-08-05 10:20:29 +02:00
9e859e1258
GH-95685: Fix rendering of the string documentation (GH-95686) (GH-95701)
...
There's an extra underlines that messed the rest of the documentation rendering.
Closes #95685
(cherry picked from commit a525f2ada4
2022-08-05 09:58:17 +02:00
2351593319
gh-65802: IDLE - explain SaveAs and extensions (GH-95690)
...
File name extensions may or may not be shown for the current name
and are added in an OS-dependent manner if not given for the new
name.
(cherry picked from commit 9890f86ae2
2022-08-04 23:26:26 -07:00
c57666586b
[3.10] Docs: sqlite3 docs fixup (GH-95681) ( #95684 )
...
- Disable links to the module itself
- Consistent ref markup
(cherry picked from commit 44f1f63ad5
2022-08-05 06:41:09 +02:00
54ea127923
[3.10] gh-95271: Extract placeholders howto from sqlite3 tutorial (GH-95522) ( #95678 )
...
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit b24e8b28a7
2022-08-04 22:53:51 +02:00
4a204c1486
[3.10] gh-95273: Improve documented return values and exceptions raised for sqlite3 class methods (GH-95530) ( #95674 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit 12d92c733c
2022-08-04 22:14:02 +02:00
f6b1c5e454
Docs: fix two typos in the sqlite3 docs (GH-95661)
...
- statment => statement
- transaciton => transaction
(cherry picked from commit 962acd4468
2022-08-04 11:34:37 -07:00
be30a6dc4d
gh-91838: Resolve HTTP links which redirect to HTTPS (GH-95642)
...
It updates links which redirect to HTTPS with different authority or
path.
(cherry picked from commit d0d0154443
2022-08-04 06:15:01 -07:00
54d4b4d992
[3.10] gh-91838: Use HTTPS links in docs for resources which redirect to HTTPS (GH-95527) (GH-95644)
...
If an HTTP link is redirected to a same looking HTTPS link, the latter can
be used directly without changes in readability and behavior.
It protects from a men-in-the-middle attack.
This change does not affect Python examples..
(cherry picked from commit f79547a429
2022-08-04 12:19:44 +03:00
76d29a8ae8
gh-95423: Update winreg.DeleteKeyEx documentation and remove dynamic function load (GH-95521)
...
Co-authored-by: Derek Kim <ddkim1024@gmail.com>
2022-08-03 22:52:15 +01:00
ac005ea860
[3.10] gh-95273: Align sqlite3 const doc refs with the devguide recommendations (GH-95525). ( #95618 )
...
(cherry picked from commit 4d02572f8c
2022-08-03 23:04:35 +02:00
8a7bf2d28c
gh-95233: Correct grp.getgrgid parameter name in documentation (gid -> id) (gh-95232)
...
(cherry picked from commit df7c8b9537
2022-08-02 08:02:33 -07:00
a1579ade9c
gh-95516: Add param types and clarify param descriptions of LogRecord (GH-95517) ( #95565 )
...
(cherry picked from commit 75a6441718
2022-08-02 15:05:46 +02:00
6765a784a7
[3.10] gh-94635: Add Reference, How-to, and Explanation headings to sqlite3 docs (GH-94636) ( #95483 )
...
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 6c439b978b
2022-07-31 08:47:53 +02:00
f14ced6062
gh-95273: Relocate sqlite3 enable load extension note (GH-95430)
...
(cherry picked from commit d92b19e1b5
2022-07-29 12:36:58 -07:00
3417ce3489
gh-95432: Fixup sqlite3 tutorial example (GH-95431)
...
- the insert statement should have five placeholders, not four
- missing ... in the multiline row list
(cherry picked from commit 2fbee85931
2022-07-29 05:38:08 -07:00
a41b51d2ea
gh-95273: Improve sqlite3 class descriptions (GH-95379)
...
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit e003b64f40
2022-07-29 03:00:29 -07:00
2278dc7442
gh-95273: Condense sqlite3 executescript example (GH-95383) ( #95419 )
...
(cherry picked from commit e9c8de669d
2022-07-29 10:44:29 +02:00
f59a5c5363
gh-95273: Move sqlite3 executemany examples from reference to tutorial (GH-95351)
...
(cherry picked from commit f0bf7956e6
2022-07-29 00:48:55 -07:00
5632c98f4a
Improve documentation for adding datetime and timedelta (gh-95403) (gh-95409)
...
(cherry picked from commit 6e44bf9558
2022-07-28 20:15:24 -04:00
196523f32b
gh-86128: Add warning to ThreadPoolExecutor docs about atexit behaviour (GH-94008)
...
(cherry picked from commit 7df2f4d787
2022-07-28 15:48:19 -07:00
dcb6fa8099
Docs: Fix refs & tweak wording in sqlite3 'Using shortcut methods' ( #95358 )
...
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit ea269b9a38
2022-07-28 12:32:20 +02:00
2ef7a72682
[3.10] gh-95273: Normalise sqlite3 reference wording (GH-95274) ( #95330 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 2361908a9d
2022-07-27 15:42:59 +02:00
7e7a570818
gh-94630: Fixup sqlite3 argument spec docs for connection execute* methods (GH-95319)
...
(cherry picked from commit 2b37395612
2022-07-27 05:54:14 -07:00
321b8bbf0f
gh-94635: Add sqlite3 'Introduction' and 'Tutorial' doc headings (GH-95269)
...
(cherry picked from commit 2e35a13e46
2022-07-26 22:49:29 -07:00
a4fd732155
[3.10] gh-95235: Add explicit parameter list to some sqlite3 methods (GH-95240) ( #95268 )
...
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 5012bedc7c
2022-07-26 10:12:50 +02:00
0418d9f2f3
gh-95235: Document undocumented parameters in sqlite3 functions and methods (GH-95236)
...
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit ac6a94c669
2022-07-25 09:55:46 -07:00
e50a63ed18
Closes gh-95133: docs, fix indentation level in TestCase.assertLogs example (GH-95134)
...
(cherry picked from commit 2a9c227ac1
2022-07-22 09:45:58 -07:00
02f1cac282
gh-81040: Improve sqlite3.Cursor.rowcount docs (GH-94940)
...
(cherry picked from commit f9b3706df6
2022-07-22 00:41:56 -07:00
95ae29d508
Fix incorrect double indent in ast doc (GH-94976)
...
Warning directive indent was 4 rather than 3 spaces.
(cherry picked from commit a25a803c4c
2022-07-18 10:33:47 -07:00
a923eb47c2
In ast doc, update 'below' to 'above' (GH-94967)
...
The included asdl file was moved from 'below' to 'above' in 3.9.
(cherry picked from commit 7b617be4ab
2022-07-18 09:45:09 -07:00
6654392587
Add additional pointers to pathlib's mapping to os.path functions (GH-94828)
...
* Add additional pointers to pathlib's mapping to os.path functions
os.path.splitext has a somewhat quirky signature since it mixes the path and filename components but I wanted the documentation to mention `PurePath.stem` as the natural counterpart to `PurePath.suffix` for the common use of `os.path.splitext` to turn "file.py" into "file" and "py".
Technically this could have some discussion of how to handle the parent directory hierarchy but that seems a bit out of keeping with the spirit of this table so I omitted mentioning `PurePath.parents` here.
* Update Doc/library/pathlib.rst
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 3789c63577
2022-07-15 15:16:45 -07:00
c5bf768a53
[3.10] [doc] Update cookbook example and add information about queue types. (GH-94854) (GH-94872)
...
(cherry picked from commit dc54193095
2022-07-15 08:18:30 +01:00
1cf0305ba5
Docs: fix typo in sqlite3.rst (GH-94798)
...
Colum -> Column
(cherry picked from commit 9ea72e9d8d
2022-07-14 14:58:14 -07:00
30015de723
GH-77265: Document NaN handling in statistics functions that sort or count (GH-94676) ( #94725 )
2022-07-10 12:36:01 -05:00
da4912885f
Use mdash-es consistently in the library docs index (GH-92762)
...
(cherry picked from commit efb20a97c4
2022-07-08 07:50:56 -07:00
691d26a17f
[3.10] gh-94622: Add more references to the sqlite3 types anchor (GH-94623). ( #94679 )
...
(cherry picked from commit e5b841a403
2022-07-08 02:50:12 +02:00
797745e749
[3.10] gh-94321: Document sqlite3.PrepareProtocol (GH-94620) ( #94671 )
...
(cherry picked from commit fb6dccae34
2022-07-08 01:44:09 +02:00
860aefaeca
gh-92743: Remove copyright sign next to "Raymond Hettinger" ( #94665 )
...
Closes GH-92743
2022-07-07 14:31:39 -07:00
663aa6e7d9
[3.10] gh-94628: Add explicit parameter list to sqlite3.connect docs (GH-94629) ( #94646 )
...
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 3eb2b9634f
2022-07-07 10:46:29 +02:00
7f45ae859a
gh-94630: Update sqlite3 docs with positional-only and keyword-only symbols (GH-94631)
...
(cherry picked from commit 94988603f3
2022-07-06 16:21:05 -07:00
7e3b6affa0
gh-94017: Improve clarity of sqlite3 transaction handling docs (GH-94320)
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 760b8cf0c8
2022-07-06 14:07:36 -07:00
fd34bfe484
[3.10] gh-91330: Tests and docs for dataclass descriptor-typed fields (GH-94424) (GH-94577)
...
Co-authored-by: Erik De Bonte <erikd@microsoft.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 5f319308a8
2022-07-05 20:45:02 +02:00
3287e45847
[3.10] bpo-46755: Don't log stack info twice in QueueHandler (GH-31355) (GH-94565)
...
Co-authored-by: Erik Montnemery <erik@montnemery.com>
2022-07-05 16:04:29 +01:00
6e47020d31
[3.10] Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94558)
...
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
(cherry picked from commit 3440d197a5
2022-07-05 14:30:37 +02:00
817414321c
[3.10] Update logging documentation: change cross-reference and add webapp r… (GH-94542)
2022-07-04 09:10:13 +01:00
d793ebc11d
IDLE doc: Tweek RESTART and Windows console start (GH-94530)
...
(cherry picked from commit 39c29f753e
2022-07-03 10:39:20 -07:00
cf1732619a
gh-81054: Document that SimpleHTTPRequestHandler follows symbolic links (GH-94416) (GH-94493)
...
(cherry picked from commit 80aaeabb8b
2022-07-01 18:41:40 +02:00
e55cd03c15
Update code sample when importing modules in queue doc (GH-94244) (GH-94491)
...
In the queue documentation, the code snippet shows the import to be not PEP 8 compliant.
Since people typically copy-paste from such code samples, I think it's important to show best-practices here.
(cherry picked from commit ad55147c1d
2022-07-01 18:15:06 +02:00
b8544e18e6
multiprocessing.spawn doc: Capitalize the p in "Python" (gh-94462)
...
(cherry picked from commit 62bb7a3b50
2022-06-30 11:22:58 -07:00
d915ed2978
xml.dom.minidom docs: fix typo (GH-93437)
...
(cherry picked from commit 639e35108b
2022-06-30 10:16:06 -07:00
e721da5d39
gh-89038: [doc] update dis.findlinestarts documentation for changes related to PEP-626 (GH-94247) (GH-94449)
...
(cherry picked from commit d68f2d27bb
2022-06-30 16:39:48 +01:00
2bf974ec84
[3.10] bpo-92336: [doc] clarify that the dfile is read by the traceback display code (GH-94409) (GH-94429)
...
(cherry picked from commit 68fb03249f
2022-06-29 13:54:44 -07:00
eb7d354817
[3.10] gh-82006: IDLE doc improvements (GH-94349) (GH-94358)
...
0. Update text start and stop conditions.
1. Title-case sections but not subsections.
2. Edit Shell Window sections: title, execute, restart.
(cherry picked from commit e6391e08bf
2022-06-28 12:50:58 +02:00
5f3b45a7f4
gh-70474: [doc] fix wording of GET_ANEXT doc (GH-94048)
...
(cherry picked from commit 9af6b75298
2022-06-25 15:52:06 -07:00
deb4d0457f
[3.10] gh-90016: Reword sqlite3 adapter/converter docs (GH-93095) ( #94273 )
...
Also add adapters and converter recipes.
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com.
(cherry picked from commit bd3c1c187e
2022-06-25 22:55:38 +02:00
64892c5e36
Docs: Remove `Provides [...]` from `multiprocessing.shared_memory` description (GH-92761)
...
(cherry picked from commit a91ffcf3fa
2022-06-24 10:16:54 -07:00
e51a22b6f6
gh-74696: Do not change the current working directory in shutil.make_archive() if possible (GH-93160) (GH-94106)
...
It is no longer changed when create a zip or tar archive.
It is still changed for custom archivers registered with shutil.register_archive_format()
if root_dir is not None.
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit fda4b2f063
2022-06-22 11:18:37 +02:00
ad2e9f97c2
bpo-30535: [doc] state that sys.meta_path is not empty by default (GH-94098) (GH-94100)
...
Co-authored-by: Windson yang <wiwindson@outlook.com>
(cherry picked from commit 6575841266
2022-06-21 23:05:08 +01:00
9ab245f8ca
[3.10] gh-93675: Fix typos in `Doc/` (GH-93676) (GH-94080)
...
Closes GH-93675
(cherry picked from commit 830513754d
2022-06-21 21:39:08 +02:00
38fdff9274
[3.10] gh-93851: Fix all broken links in Doc/ (GH-93853) (GH-94078)
...
(cherry picked from commit f62ff97f31
2022-06-21 21:37:09 +02:00
223fde359a
gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)
...
* Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)"
This reverts commit 5c1f15b4b1b63a6200140efe3a1636
2022-06-21 10:51:23 -07:00
cdf3689aa5
gh-61162: Clarify sqlite3 connection context manager docs (GH-93890)
...
Explicitly note that transactions are only closed if there is an open
transation at `__exit__`, and that transactions are not implicitly
opened during `__enter__`.
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Automerge-Triggered-By: GH:erlend-aasland
(cherry picked from commit 8e08978141
2022-06-19 13:25:55 -07:00
c4440e6bc0
[3.10] gh-93925: Improve clarity of sqlite3 commit/rollback, and close docs (GH-93926) ( #94011 )
...
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 6446592c89
2022-06-19 21:43:03 +02:00
5163a25354
gh-91877: Fix WriteTransport.get_write_buffer_{limits,size} docs ( #92338 ) ( #93805 )
...
- Amend docs for WriteTransport.get_write_buffer_limits
- Add docs for WriteTransport.get_write_buffer_size
Co-authored-by: Sanket Shanbhag <TechieBoy@users.noreply.github.com>
2022-06-16 18:19:17 +02:00
e929dae42a
gh-93857: Fix broken audit-event targets in sqlite3 docs (GH-93859)
...
Corrected targets for the following audit-events:
- sqlite3.enable_load_extension => sqlite3.Connection.enable_load_extension
- sqlite3.load_extension => sqlite3.Connection.load_extension
(cherry picked from commit ce4d11f98b
2022-06-15 07:24:50 -07:00
5dee1d840c
gh-87260: Update sqlite3 signature docs to reflect actual implementation (GH-93840)
...
Align the docs for the following methods with the actual implementation:
- sqlite3.complete_statement()
- sqlite3.Connection.create_function()
- sqlite3.Connection.create_aggregate()
- sqlite3.Connection.set_progress_handler()
(cherry picked from commit d31834688b
2022-06-15 03:46:33 -07:00
56ee410053
[3.10] gh-89018: Improve documentation of `sqlite3` exceptions (GH-27645) ( #93838 )
...
- Order exceptions as in PEP 249
- Reword descriptions, so they match the current behaviour
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit bb0b768946
2022-06-15 11:55:30 +02:00
095d09c0a8
gh-93183: Adjust wording in socket docs (GH-93832)
...
package => packet
Co-authored-by: Victor Norman
(cherry picked from commit cdd3984307
2022-06-15 01:51:28 -07:00
58277de8e6
Change list to view object (GH-93661)
...
(cherry picked from commit 5d8e7a1240
2022-06-11 04:13:38 -07:00
9fafc0acf7
gh-91317: Document that Path does not collapse initial `//` (GH-32193)
...
Documentation for `pathlib` says:
> Spurious slashes and single dots are collapsed, but double dots ('..') are not, since this would change the meaning of a path in the face of symbolic links:
However, it omits that initial double slashes also aren't collapsed.
Later, in documentation of `PurePath.drive`, `PurePath.root`, and `PurePath.name` it mentions UNC but:
- this abbreviation says nothing to a person who is unaware about existence of UNC (Wikipedia doesn't help either by [giving a disambiguation page](https://en.wikipedia.org/wiki/UNC ))
- it shows up only if a person needs to use a specific property or decides to fully learn what the module provides.
For context, see the BPO entry.
(cherry picked from commit 78f1a43694
2022-06-10 16:10:29 -07:00
a2695be91c
[3.10] Improve logging documentation with example and additional cookbook re… (GH-93644) (GH-93648)
...
(cherry picked from commit e974b3e333
2022-06-10 16:31:00 +02:00
2139583bf9
Doc: Update references and examples of old, unsupported OSes and uarches (GH-92791) (GH-93639)
...
(cherry picked from commit a5ba0f4ebc
2022-06-09 16:15:49 +02:00
6b9122483f
[3.10] Fix `PurePath.relative_to` links in the pathlib documentation (GH-93268) (GH-93590)
...
These are currently broken as they refer to :meth:`Path.relative_to` rather than :meth:`PurePath.relative_to`, and `relative_to` is a method on `PurePath`..
(cherry picked from commit 8ef7929baf#93268
2022-06-07 14:58:43 -07:00
c7b5a2d5ea
gh-88831: In docs for asyncio.create_task, explain why strong references to tasks are needed (GH-93258) (GH-93567)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 75ceae05c1
2022-06-07 12:14:25 +02:00
386babebe9
gh-93391: fix typo in `array` docs (GH-93392) (GH-93395)
...
Fixes GH-93391
(cherry picked from commit fc694364cc
2022-06-06 19:14:04 +02:00
ce057ae1e3
gh-93372: Fix typo in os.rename documentation (GH-93401) (GH-93404)
...
(cherry picked from commit e7aab7c92a
2022-06-06 19:11:18 +02:00
3d19051386
📝 Make sure the phrase "constant-time compare" actually appears in the docs (GH-93396) ( #93400 )
...
This is purely for SEO as this is the actual generic name for this kind of method and it currently does not appear in a Google search for "python constant time compare". Not creating an issue or setting this up for backports as its trivial (I think) and not a functional change.
(cherry picked from commit 8241a6971e
2022-06-06 18:54:04 +02:00
0b7aae88d0
Remove the execution bit to some socket-related files. (GH-93368)
...
(cherry picked from commit 5247389369
2022-06-01 00:31:31 -07:00
aa06a84099
bpo-42272: fix misleading warning filter message/module docs (GH-23172)
...
* bpo-42272: improve message/module warning filter docs
"The Warnings Filter" section of the warnings module documentation
describes the message and module filters as "a string containing a
regular expression". While that is true when they are arguments to the
filterwarnings function, it is not true when they appear in -W or
$PYTHONWARNINGS where they are matched literally (after stripping any
starting/ending whitespace). Update the documentation to note when they
are matched literally. Also clarify that module matches the
"fully-qualified module name", rather than "module name" which is
ambiguous.
skip news (since this is a doc fix)
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
* bpo-42272: remove bad submodule warning filter doc
The `error:::mymodule[.*]` example in the "Describing Warning Filters"
section of the warnings module documentation does not behave as the
comment describes. Since the module portion of the filter string is
interpreted literally, it would match a module with a fully-qualified
name that is literally `mymodule[.*]`.
Unfortunately, there is not a way to match '"module" and any subpackages
of "mymodule"' as documented, since the module part of a filter string
is matched literally. Instead, update the filter and comment to match
only "mymodule".
skip news (since this is a doc fix)
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
* bpo-42272: add warning filter doc changes to NEWS
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
(cherry picked from commit 8136606769
2022-05-29 19:03:15 -07:00
9912b3d989
gh-77024: test.support: Improve documentation (GH-92513)
...
This is a rework of GH-5774 on current main. I was a bit more
conservative in making changes than the original PR.
See @csabella's comments on issue GH-77024 and the discussion
on GH-5774 for explanations of several of the changes.
Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 8995177030
2022-05-27 12:25:21 -07:00
251104f12d
[3.10] gh-92859: Doc: add info about logging.debug() calling basicConfig() (GH-93063) (GH-93150)
2022-05-23 20:45:44 +01:00
936eefcb82
gh-92994: Clarify importlib "check" example (GH-92995)
...
Fixes GH-92994
(cherry picked from commit e39cd76561
2022-05-22 19:11:58 -07:00
619a67cc06
gh-73137: Added sub-subsection headers for flags in re (GH-93000)
...
Fixes GH-73137
(cherry picked from commit b7a6610bc8
2022-05-22 19:06:54 -07:00
54b5e4da8a
gh-91362: reword pickle docs to account for nested classes (GH-92429)
...
Fixes GH-91362
(cherry picked from commit f9d6c59917
2022-05-21 08:10:56 -07:00
3c2a1e7f4a
[3.10] gh-72073: Add Windows case in pathlib.rename (GH-93002) (GH-93029)
...
GH-72073
https://docs.python.org/3.12/library/pathlib.htmlGH-pathlib.Path.rename
(cherry picked from commit f51ed04c66
2022-05-20 15:44:07 -07:00
4d363d8989
Doc: add missing manpage and title references in tkinter docs (GH-29008)
...
- add bind(3tk) manpage markup
- add Tcl/Tk book reference markup
(cherry picked from commit 0e12781ad9
2022-05-20 02:21:29 -07:00
5d7f3dc3dc
bpo-46879: Fix incorrect sphinx object names in doc (GH-31615) (GH-92975)
...
(cherry picked from commit 2cdd57f119
2022-05-19 17:57:46 +02:00
3d47035686
gh-92417: `subprocess` docs: remove note on compatibility with Python <3.5 (GH-92538) (GH-92973)
...
(cherry picked from commit 84b86000e2
2022-05-19 17:49:13 +02:00
93ebac7a79
gh-92417: `fractions`, `decimal`: Improve docs for alternative constructor methods (GH-92421) (GH-92971)
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 090df844ea
2022-05-19 17:45:30 +02:00
ebf3f12c38
gh-92417: `socket` docs: remove references to Python <3.3 (GH-92544) (GH-92969)
...
(cherry picked from commit 639b62c9c4
2022-05-19 17:44:31 +02:00
4e289e20e2
gh-92417: Update docs and examples of doctest.IGNORE_EXCEPTION_DETAIL for Py>=3 (GH-92502) (GH-92963)
...
(cherry picked from commit 97b9c1096f
2022-05-19 17:19:53 +02:00
3e534b464a
Doc: amend ssl.PROTOCOL_SSLv2 and ssl.PROTOCOL_SSLv3 wording (GH-92634)
...
(cherry picked from commit 41638967a0
2022-05-19 02:40:39 -07:00
17524b084b
gh-92812: Align ArgumentParser.add_subparsers() docs with argument spec (GH-92814)
...
(cherry picked from commit f2d994da10
2022-05-18 14:30:00 -07:00
ed75d2183f
bpo-40838: document `getdoc`, `getmodule`, `getsourcefile` in `inspect` returns `None` (GH-30575)
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit b86d783a4e
2022-05-18 05:49:15 -07:00
94e21cf229
gh-92780: Improve sqlite3.Connection.create_collation docs (GH-92790)
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 7ee19e2715
2022-05-18 05:05:24 -07:00
56e9fb3e3b
Fix typo in argparse docs. (GH-92691) ( #92729 )
2022-05-13 16:09:06 -05:00
597ff24188
gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612)
...
(cherry picked from commit 9f68dab3d3
2022-05-13 13:11:05 -07:00
5d62759f98
gh-92436: __future__ docs: add note on expectations for "from __future__ import annotations" (GH-92568)
...
(cherry picked from commit 6582c96454
2022-05-12 07:42:57 -07:00
9f29bdd8f0
Fix minor documentation error in bisect docs (GH-92697)
...
(cherry picked from commit b3f99b69d0
2022-05-11 16:12:17 -07:00
7a84ea4ec1
[3.10] Fix typo in unittest.rst: addCleanupModule -> addModuleCleanup (GH-92631) (GH-92660)
...
(cherry picked from commit 38486ca212
2022-05-11 03:50:00 -07:00
d435ebd39e
gh-91966 Document where key functions are applied in the bisect module (GH-92602) ( #92666 )
2022-05-11 02:06:42 -05:00
dd0e8a62df
[3.10] gh-76773: Update docs mentioning no-longer-supported Windows versions & features (GH-92529) (GH-92609)
...
(cherry picked from commit f1bbcba74f
2022-05-10 02:28:22 -07:00
5ed2f11834
bpo-13553: Document tkinter.Tk args (GH-4786)
...
(cherry picked from commit c56e2bb994
2022-05-09 21:27:37 -07:00
cd11068712
bpo-38056: overhaul Error Handlers section in codecs documentation (GH-15732)
...
* Some handlers were wrongly described as text-encoding only, but actually they can also be used in text-decoding.
* Add more description to each handler.
* Add two REPL examples.
* Add indexes for Error Handler's name.
Co-authored-by: Kyle Stanley <aeros167@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 5bc2390229
2022-05-08 20:16:26 -07:00
158579654d
bpo-39229: fix formatting in library/functions.rst (GH-17857)
...
Missing reference of auditing event presents error when building translated documentation
(cherry picked from commit f298ba1f27
2022-05-08 16:39:09 -07:00
6679fdf4f0
pdb docs: workaround for double semicolon in strings (GH-17011)
...
see https://github.com/gotcha/ipdb/issues/172
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 2888b1107f
2022-05-08 16:38:47 -07:00
1dbf69979f
gh-80856: doc: reveal doctest directives (GH-92318)
...
* Doc: Reveal doctest directives.
* Fix whitespace.
Co-authored-by: Julien Palard <julien@palard.fr>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 7b024e3a3f
2022-05-08 09:32:20 -07:00
15cb6e8b8b
gh-92417: `logging` docs: Remove warning that only applies to Python <3.2 (GH-92425)
...
(cherry picked from commit 318c4e91ef
2022-05-08 09:03:09 -07:00
e363034752
[3.10] gh-92417: `asyncio` docs: `asyncio.run()` is available on all supported Python versions (GH-92419) (GH-92463)
...
(cherry picked from commit f4e317b304
2022-05-08 08:30:43 -07:00
2164b5bad7
[3.10] gh-92417: `json` docs: `dict` is ordered on all supported Python versions (GH-92422) (GH-92465)
...
(cherry picked from commit bc098cfdb7
2022-05-08 08:30:18 -07:00
45ed69b200
[3.10] gh-92417: `doctest` docs: remove references to Python <3.6 (GH-92420) (GH-92468)
...
(cherry picked from commit 5639ea1ef9
2022-05-08 08:29:50 -07:00
a7d869a2ea
[3.10] gh-77630: Change Charset to charset (GH-92439) (GH-92476)
...
(cherry picked from commit 8f29318079
2022-05-08 08:28:06 -07:00
8c42fefa39
[3.10] gh-92417: `stdtypes` docs: delete discussion of Python 2 differences (GH-92423) (GH-92473)
...
Given that 2.7 has now been end-of-life for two and a half years,
I don't think we need such a detailed explanation here anymore of
the differences between Python 2 and Python 3.
(cherry picked from commit 8efda1e7c6
2022-05-08 08:26:06 -07:00
80ce70110b
gh-92417: `typing` docs: `from __future__ import annotations` can be used in all supported Python versions (GH-92418)
...
(cherry picked from commit e5b4bd4d60
2022-05-08 08:04:18 -07:00
bb2dcf1c79
gh-92223: Remove pre-Python 3.7 alternative in asyncio docs (GH-92224)
...
(cherry picked from commit d1b2e989be
2022-05-04 17:30:54 -07:00
31d9a88ca8
[3.10] Improve the typing docs (GH-92264) ( #92270 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit 27e3665715
2022-05-03 16:41:39 -06:00
5f40cb85c2
bpo-46586: Fix more erroneous doc links to builtins (GH-31429)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Éric <merwok@netwok.org>
(cherry picked from commit cc6ae4f483
2022-05-02 15:51:33 -07:00
f44e629a57
bpo-6686: Replace String with Bytes in xml.sax.handler documentation (GH-30612)
...
(cherry picked from commit 32e4f450af
2022-05-02 15:44:07 -07:00
d851f37b88
importlib docs: Update importlib.abc hierarchy (GH-31113)
...
Fixed some inconsistencies in the text about relationships
(cherry picked from commit 5f45a9d3c3
2022-05-02 13:48:59 -07:00
c8ab1633fc
[3.10] bpo-43504: Remove effbot urls (GH-26308) ( #92161 )
...
* [3.10] Remove effbot urls (GH-26308).
(cherry picked from commit e9f66aedf4
2022-05-02 12:21:51 -06:00
bab4d0bb16
gh-91783: Document security considerations for shutil.unpack_archive (GH-91844)
...
(cherry picked from commit 4b297a9ffd
2022-05-02 10:34:59 -07:00
0e9927b6b0
gh-92082: contextlib docs: Change aclosing from a class to a function for consistency (GH-92155)
...
Signed-off-by: prwatson <prwatson@redhat.com>
(cherry picked from commit 958f21c5cd
2022-05-02 09:37:10 -07:00
446cc03730
gh-88546: glob.glob docs: Make new paragraph for emphasis and reordered sentence (GH-91614)
...
(cherry picked from commit b9ab6cea08
2022-05-02 08:35:37 -07:00
9941640041
asyncio.subprocess: Fix a typo in doc (GH-92030)
...
Remove a confusion for read method in asyncio-subprocess doc for stderr StreamReader instance
(cherry picked from commit bb857a96ef
2022-05-02 08:18:01 -07:00
9ce39cc9f2
gh-85133: os docs: Add that getenv uses os.environ (GH-91874)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit b25352a5c0
2022-05-02 07:58:09 -07:00
bba721d0fa
gh-84714: Add behavior if dst file exists (GH-91867)
...
(cherry picked from commit 9166ace805
2022-05-02 07:51:07 -07:00
e7de543219
typing docs: Add example for async functions (GH-20386)
...
Fixes python/typingGH-424
(cherry picked from commit 9588f880a2
2022-04-30 21:55:58 -07:00
a48d31f204
gh-81488: Add recursive wording for issubclass docs (GH-92087)
...
(cherry picked from commit 1066ecb970
2022-04-30 21:21:51 -07:00
31e35bef22
gh-91611: Use example.com for documentation, not mydomain.com (GH-91613)
...
example.com is reserved by the IANA as special-use domain name for documentation
purposes. The domain names are used widely in books, tutorials, sample network
configurations, and generally as examples for the use of domain name.
On the other hand, mydomain.com is real Domain Name Registration service.
(cherry picked from commit ea39246782
2022-04-30 21:03:11 -07:00
335aae1950
gh-87801: Add run() to subprocess.CalledProcessError description (GH-91628)
...
(cherry picked from commit 567be058b4
2022-04-30 14:51:45 -07:00
cfcda0acf2
gh-87192: Update wording for fcntl 'Changed in' (GH-91658)
...
(cherry picked from commit d7eb1ffbe8
2022-04-30 14:44:08 -07:00
Miss Islington (bot)