Commit graph

23761 commits

Author SHA1 Message Date
Miss Islington (bot)
fd2c2465d4
bpo-44756: in ./Doc, make build depends on make html (GH-27403) (GH-27411)
- venv rule is now conditional, and only does anything if $VENVDIR does not exist
- add rule "clean-venv"
(cherry picked from commit d22c876d5a)

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
2021-07-28 15:40:18 +02:00
Miss Islington (bot)
cc602a71df
docs: replace "Mac OS X" -> "macOS" (GH-27364) (GH-27375)
"Mac OS X" has been rebranded as macOS

https://www.apple.com/macos
(cherry picked from commit 5fdd2a14ce)

Co-authored-by: partev <petrosyan@gmail.com>
2021-07-26 16:22:58 -04:00
Miss Islington (bot)
3f1389459a
The current documentation says it returns None if the name is not found, but (GH-26785) (GH-27372)
the implementation uses [] and will raise KeyError instead.

Noticed by @srittau in python/typeshed@5659.
(cherry picked from commit f22737abfa)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2021-07-26 21:35:46 +02:00
Miss Islington (bot)
7482fff297
bpo-43443: Clarify difference between shelve objects and dicts (GH-27004) (GH-27370)
(cherry picked from commit c97c2a050c)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2021-07-26 21:32:49 +02:00
Miss Islington (bot)
4ce6c5285a
bpo-44693: Update __future__ entry in Doc/glossary.rst (GH-27349) (GH-27358)
Replace sentence with confusing "pseudo-module" with two sentences
separating future statements and the __future__ module.

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit 0363a4014d)

Co-authored-by: Steven Hsu <hsuhaochun@gmail.com>

Co-authored-by: Steven Hsu <hsuhaochun@gmail.com>
2021-07-25 21:40:36 -04:00
Miss Islington (bot)
5a0c6abb56
[3.9] bpo-44399: Update logging cookbook to document patterns to be avoided. (GH-27348) (GH-27350)
(cherry picked from commit 9751f85914)
2021-07-25 20:32:15 +01:00
Miss Islington (bot)
ce2033694e
[3.9] bpo-43184: Add information about added attribute and method. (GH-27347) (GH-27353)
(cherry picked from commit 50b72768ff)
2021-07-25 20:30:11 +01:00
Miss Islington (bot)
5d9c86e340
bpo-44713: [doc fix]: typo in subprocess.rst (GH-27297) (#27327)
This fixes a small typo. The code fragment should not be quoted. Thank you
@merwok for the feedback.
(cherry picked from commit 7d25254cf0)

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
2021-07-24 12:30:25 +02:00
Miss Islington (bot)
5ffbb05f1c
bpo-14879: [doc] clarify how to check for errors from subprocess.Popen(..., shell=True) (GH-26755) (GH-27289)
(cherry picked from commit 50ffbe3daf)

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
2021-07-22 19:25:31 +01:00
Miss Islington (bot)
654ead25ab
Fix typo in collections.rst (GH-27270) (#27284) 2021-07-22 10:38:40 +02:00
Miss Islington (bot)
c8e35abfe3
bpo-30511: Add note on thread safety to shutil.make_archive() (GH-26933) (GH-27275)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 64f54b7ccd)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-07-21 11:04:42 +02:00
Miss Islington (bot)
2f643b1a8c
[3.9] bpo-44561: Update hyperlinks in Doc/distributing/index.rst (GH-27032) (GH-27233)
* Update hyperlinks in Doc/distributing/index.rst

Update three expired hyperlinks.

Closes [bpo-44561]().
(cherry picked from commit b494685b25)


Co-authored-by: Steven Hsu <hsuhaochun@gmail.com>

Automerge-Triggered-By: GH:ncoghlan
2021-07-18 17:39:03 -07:00
Miss Islington (bot)
049e98b2b7
[3.9] bpo-43958: Document importlib.metadata.PackagePath.locate method (GH-25669) (GH-27221)
(cherry picked from commit b38b2fa021)


Co-authored-by: Paul Moore <p.f.moore@gmail.com>

Automerge-Triggered-By: GH:jaraco
2021-07-17 19:53:00 -07:00
Miss Islington (bot)
421b543311
bpo-44639: fix typo in sqlite.rst (transation => transaction) (GH-27145) (GH-27149)
To my understanding, this is supposed to say "transaction".

See the relevant source:

a158b20019/Modules/_sqlite/connection.cGH-L1434-L1467
(cherry picked from commit 1ca27f2647)

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
2021-07-14 23:49:33 +01:00
Miss Islington (bot)
a3d20bfee3
bpo-43126: Expand docs on io.IOBase.readlines() method (GH-27061) (#27114)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 3b5b99da4b)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-07-13 16:41:31 +02:00
Miss Islington (bot)
105e6cd67c
bpo-44514: Add doctest testcleanup for configparser and bz2 (GH-26909) (#27111)
Add testcleanup section to configparser and bz2 documentation which
removes temporary files created in the filesystem when 'make doctest'
is run.
(cherry picked from commit 48a5aa7f12)

Co-authored-by: Kevin Follstad <kfollstad@gmail.com>
2021-07-13 16:33:50 +02:00
Miss Islington (bot)
c786988b19
bpo-42194: Add "New in version: 3.9" to argparse.BooleanOptionalAction (GH-23026) (#27098)
(cherry picked from commit da2e673c53)

Co-authored-by: David Sanders <shang.xiao.sanders@gmail.com>
2021-07-12 18:23:25 +02:00
Miss Islington (bot)
47abf24036
bpo-26329: update os.path.normpath documentation (GH-20138) (#27095)
(cherry picked from commit 66c5853406)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
2021-07-12 17:22:33 +02:00
Miss Islington (bot)
779983ed7f
bpo-43207: InspectLoader.is_package is not an abstract method (GH-24517) (#26322)
Making the description of `InspectLoader.is_package` aligned with the current implementation.

Automerge-Triggered-By: GH:jaraco
(cherry picked from commit 8b9310d902)

Co-authored-by: Junnosuke Kuroda <Isa-rentacs@users.noreply.github.com>
2021-07-12 17:11:59 +02:00
Miss Islington (bot)
302df02789
docs: add the word 'official' (GH-26849)
(cherry picked from commit af4a2dcc40)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2021-07-08 08:21:55 -07:00
Steve Dower
863e3d5c7e
bpo-41180: Replace marshal code.__new__ audit event with marshal.load[s] and marshal.dumps (GH-26971) 2021-06-30 18:52:39 +01:00
Miss Islington (bot)
02859df105
bpo-38062: [doc] clarify that atexit uses equality comparisons internally. (GH-26935) (GH-26957)
(cherry picked from commit 12803c59d5)

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
2021-06-29 18:53:07 +01:00
Miss Islington (bot)
3ba65cdcef
bpo-42588: Update the docs for the TopologicalSorter.static_order() method (GH-26834) (GH-26952)
(cherry picked from commit 0d7f7975d5)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-06-29 15:19:05 +01:00
Jason R. Coombs
17b916737b
[3.9] bpo-37741: make importlib.metadata docs discoverable through a module directive. (GH-25415) (GH-26500)
Automerge-Triggered-By: GH:jaraco.
(cherry picked from commit 23acadcc1c)

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
2021-06-27 18:05:27 -04:00
Miss Islington (bot)
1acd1e6385
bpo-40620: Clarify tutorial controlflow.rst `range` examples (GH-26919) (GH-26928)
(cherry picked from commit 2f49c9debc)

Co-authored-by: jdevries3133 <58614260+jdevries3133@users.noreply.github.com>
2021-06-27 20:52:32 +01:00
Victor Stinner
5ed7827b16
bpo-44441: _PyImport_Fini2() resets PyImport_Inittab (GH-26874) (GH-26878)
Py_RunMain() now resets PyImport_Inittab to its initial value at
exit. It must be possible to call PyImport_AppendInittab() or
PyImport_ExtendInittab() at each Python initialization.

(cherry picked from commit 489699ca05)
2021-06-23 17:47:33 +02:00
Miss Islington (bot)
ef89b2bf42
[doc] Improve punctuation atexit doc (GH-25629) (GH-26857)
(cherry picked from commit a6b47de07a)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2021-06-22 18:10:50 +01:00
Miss Islington (bot)
a65df3f9fc
bpo-41621: Document defaultdict's default_factory parameter (GH-21945)
It defaults to None and is positional only.
(cherry picked from commit d1ae57027f)

Co-authored-by: Dennis Sweeney <36520290+sweeneyde@users.noreply.github.com>
2021-06-22 07:42:41 -07:00
Miss Islington (bot)
d881002fbd
bpo-13814: Explain why generators are not context managers (GH-26835)
Put entry in Design FAQ after a question about a context manager for assignment.
Original patch by Aidan Lowe.
(cherry picked from commit 51f45d085d)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-06-21 18:03:06 -04:00
Miss Islington (bot)
533bff4e9f
bpo-44426: Fix use of the C keyword 'default' as a variable name (GH-26798) (GH-26805)
(cherry picked from commit 291848195f)
2021-06-19 16:16:38 +01:00
Miss Islington (bot)
686c6f303a
bpo-44426: Use of 'complex' as a C variable name confuses Sphinx; change it to 'num'. (GH-26744) (GH-26761)
(cherry picked from commit 7247f6f433)
2021-06-16 20:13:53 +01:00
Ken Jin
c7e95715ec
[3.9] bpo-44392: Add Py_GenericAlias to C API docs (GH-26724) (GH-26757)
(cherry picked from commit 6773c3eaa7)
2021-06-16 08:34:52 -07:00
Miss Islington (bot)
7f021952b2
bpo-38291: Remove mention of typing.io and typing.re again (GH-26113)
They were originally removed in GH-10173 per bpo-35089, but then
readded in GH-21574. Cf. bpo-38291 for decision to remove.
(cherry picked from commit 8a76683cfb)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
2021-06-14 08:07:05 -07:00
Terry Jan Reedy
d5f8bd60e1
[3.9] bpo-44322: Document more SyntaxError details. (GH-26562)
1. SyntaxError args have a tuple of other attributes.
2. Attributes are adjusted for errors in f-string field expressions.
3. Compile() can raise SyntaxErrors.

(cherry picked from commit 67dfa6f2a5)
2021-06-06 22:57:53 -04:00
Miss Islington (bot)
8e2c0fd7ad
bpo-44320: Fix markup for W3C C14N test suite (GH-26556)
(cherry picked from commit 71be461704)

Co-authored-by: NAKAMURA Osamu <osamu0329nakamura@users.noreply.github.com>
2021-06-05 19:57:24 -07:00
Miss Islington (bot)
ea298e1e33
bpo-44279: revert 'exceptions are raised' back to 'exceptions occur' (GH-26492) (GH-26539)
(cherry picked from commit dda9ecbfec)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2021-06-04 23:09:45 +01:00
Irit Katriel
9a68862497
[3.9] bpo-44279: [doc] reword contextlib.suppress documentation (GH-26428) (GH-26481)
(cherry picked from commit 87272b70f1)

Co-authored-by: MapleCCC <littlelittlemaple@gmail.com>
2021-06-01 23:15:48 +01:00
Miss Islington (bot)
7bd1304d49
bpo-44263: Mention PyType_Ready in the gc protocol warning (GH-26445)
(cherry picked from commit 43cf7c864a)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2021-05-28 20:53:40 -07:00
Miss Islington (bot)
a30cbaee84
bpo-44263: Better explain the GC contract for PyType_FromSpecWithBases (GH-26442)
(cherry picked from commit 8b55bc3f93)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2021-05-28 20:20:54 -07:00
Miss Islington (bot)
bee66d3cb9
bpo-41147: [doc] contextlib.redirect_stdout() provides the new stream as context var (GH-21199) (GH-26380)
(cherry picked from commit 46db39d7bd)

Co-authored-by: Peter Law <PeterJCLaw@gmail.com>
2021-05-26 15:43:37 +01:00
Miss Islington (bot)
e7078ee116
Point to recent link to PyFLTK (GH-26315) (GH-26367)
(cherry picked from commit ee3d78ef73)

Co-authored-by: Mark <mark@qtrac.eu>

Co-authored-by: Mark <mark@qtrac.eu>
2021-05-25 18:03:43 -03:00
Miss Islington (bot)
8accb8c8cc
bpo-20408: Fix memoryview() signature in docs (GH-24431)
(cherry picked from commit d18e5dae91)

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2021-05-25 17:30:42 +03:00
Miss Islington (bot)
ab4da07923
[3.9] bpo-44195: Use 'TraversableResources' in the docs to match the implementation. (GH-26317) (GH-26335)
(cherry picked from commit 7148293d96)


Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>

Automerge-Triggered-By: GH:jaraco
2021-05-24 10:33:03 -07:00
Miss Islington (bot)
099e6a4096
bpo-30757: Improve "How to make stand-alone binaries" FAQ (GH-26309) (GH-26312)
Co-authored-by: denfromufa <denfromufa@users.noreply.github.com>
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 2a1e6698b1)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-05-22 23:23:11 +01:00
Mariusz Felisiak
b21193dd1e
[3.9] Remove duplicate words in docs. (GH-26167) (GH-26297)
(cherry picked from commit b06ed1d883)
2021-05-22 21:56:19 +01:00
Miss Islington (bot)
11b5045b0c
bpo-8264: Document hasattr and getattr behavior for private attributes (GH-23513) (GH-26238)
Clarify ``getattr`` and ``setattr`` requirements for accessing name-mangled attributes

Co-Authored-By: Catalin Iacob <iacobcatalin@gmail.com>
(cherry picked from commit 2edaf6a4fb)

Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
2021-05-22 12:06:46 +01:00
Miss Islington (bot)
a373c80811
Specify Python Cookbook edition for reference (GH-26301) (#26303)
(cherry picked from commit 604cd71e50)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-05-21 23:48:31 +01:00
Zackery Spytz
96c9961bfe
bpo-43556: Fix the attr names for ast.expr and ast.stmt in the docs (GH-24940) 2021-05-21 21:29:12 +01:00
Miss Islington (bot)
e10bd76d47
bpo-43927: Change 'IOError' to 'OSError' (GH-26289)
This is the last remaining instance, at least for this chapter, in 3.10 & 3.11.
(cherry picked from commit 2f47d8dcc7)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-05-21 11:17:10 -07:00
Miss Islington (bot)
bcd59134f5
[doc] Fix indentation in inspect documentation (GH-24846) (GH-26288)
(cherry picked from commit 642fdfdc04)

Co-authored-by: Numerlor <25886452+Numerlor@users.noreply.github.com>
2021-05-21 18:06:58 +01:00