summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* Correct trivial grammar in reset_mock docs (GH-101861)Miss Islington (bot)2023-02-131-3/+3
| | | | | (cherry picked from commit a1f08f5f19753c7c9295f51b5ae1262c7a1c838f) Co-authored-by: Steve Kowalik <steven@wedontsleep.org>
* gh-101845: pyspecific: Fix i18n for availability directive (GH-101846)Miss Islington (bot)2023-02-121-9/+11
| | | | | | | | | | | | | pyspecific: Fix i18n for availability directive If the directive has content, the previous code would nest paragraph nodes from that content inside a general paragraph node, which confuses Sphinx and leads it to drop the content when translating. Instead, use a container node for the body. Also use set_source_info so that any warnings have location info. (cherry picked from commit 6ef6915d3530e844243893f91bf4bd702dfef570) Co-authored-by: Jean Abou-Samra <jean@abou-samra.fr>
* [3.11] gh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to ↵Miss Islington (bot)2023-02-111-1/+1
| | | | | | | | properly call it a class method (GH-101391) (#GH-101813) gh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to properly call it a class method (GH-101391) (cherry picked from commit 17143e2c30ae5e51945e04eeaec7ebb0e1f07fb5) Co-authored-by: busywhitespace <busywhitespace@tuta.io>
* [3.11] Docs: Fix getstatus() -> getcode() typos (GH-101296) (#101805)Hugo van Kemenade2023-02-102-2/+2
|
* Docs: use parameter list for sqlite3.Cursor.execute* (GH-101782)Miss Islington (bot)2023-02-101-12/+33
| | | | | | (cherry picked from commit 2037ebf81bd4bbe5421421b822bd57cfd665a1e9) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-101283: Version was just released, so should be changed in 3.11.3 (GH-101719)Miss Islington (bot)2023-02-091-5/+5
| | | | | (cherry picked from commit 0e0c5d8baaa6aa91f4221c5aa57d5586e58e8652) Co-authored-by: Steve Dower <steve.dower@python.org>
* Update Lib/subprocess.pyMiss Islington (bot)2023-02-081-0/+40
|
* [3.11] gh-47937: Note that Popen attributes are read-only (GH-93070) (#101684)Miss Islington (bot)2023-02-081-11/+12
| | | | | | | | | * Note that Popen attributes aren't meant to be set by users by rewording the text about the attributes. * Also update some universal_newlines references to mention the modern text parameter name while in the area. (cherry picked from commit 027adf42cd85db41fee05b0a40d89ef822876c97) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Gregory P. Smith <greg@krypto.org>
* [3.11] gh-97725: Fix documentation for the default file of ↵Oleg Iarygin2023-02-081-1/+1
| | | | | `asyncio.Task.print_stack` (#101652) (#101653) (cherry picked from commit f87f6e23964d7a4c38b655089cda65538a24ec36)
* GH-101616: Mention the Docs Discourse forum in the "reporting docs issues" ↵Miss Islington (bot)2023-02-061-0/+3
| | | | | | | | (GH-101617) Fixes https://github.com/python/cpython/issues/101616 (cherry picked from commit 949c58f945b93af5b7bb70c6448e940da669065d) Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
* GH-56426: Add cross-reference to the documentation for faulthandler, ↵Miss Islington (bot)2023-02-043-2/+26
| | | | | | | | traceback, and pdb. (GH-101157) (cherry picked from commit cef9de62b8bf5e2d11d5a074012dfa81dc4ea935) Co-authored-by: Furkan Onder <furkanonder@protonmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* Add missing `versionadded` directive for `PyCode_Addr2Location` (GH-101347)Miss Islington (bot)2023-02-041-0/+2
| | | | | (cherry picked from commit f11a3d1ebe0c78f8c159c63a37022b9b96f720dd) Co-authored-by: Max Bachmann <oss@maxbachmann.de>
* docs: replace PyPI description with link (GH-101506)Miss Islington (bot)2023-02-031-2/+2
| | | | | (cherry picked from commit 45d014e03ba7ba4c9c912120ec36b2aca02061f4) Co-authored-by: François Magimel <magimel.francois@gmail.com>
* gh-100920: Update documentation for `asyncio.StreamWriter.wait_closed` ↵Miss Islington (bot)2023-02-031-2/+8
| | | | | | | (GH-101514) (cherry picked from commit 5c39daf50b7f388f9b24bb2d6ef415955440bebf) Co-authored-by: Viet Than <thanhoangviet@gmail.com>
* gh-100925: Move array methods under class in array doc (GH-101485)Miss Islington (bot)2023-02-031-90/+89
| | | | | | | | * Move array methods under class in array doc * Fix a few internal references related to the touched lines (cherry picked from commit 1b6045668d233269f667c4658c7240256f37f111) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* docs: Fix enum reassign `str` documentation (GH-101507)Miss Islington (bot)2023-02-021-2/+2
| | | | | (cherry picked from commit 24cbc7a2a09bf22ff8122c1d50135e1c56622c95) Co-authored-by: Peter Gessler <gesslerpd@users.noreply.github.com>
* Docs: improve accuracy of sqlite3 `check_same_thread` parameter (GH-101351)Miss Islington (bot)2023-02-021-4/+7
| | | | | | | (cherry picked from commit ee21110086e277a0ac24f5f768f35847b4db3380) Co-authored-by: Marcos Pereira <3464445+marcospgp@users.noreply.github.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-101467: Correct py.exe handling of prefix matches and cases when only one ↵Miss Islington (bot)2023-02-011-5/+30
| | | | | | | runtime is installed (GH-101468) (cherry picked from commit eda60916bc88f8af736790ffd52381e8bb83ae83) Co-authored-by: Steve Dower <steve.dower@python.org>
* gh-101498 : Fix asyncio.Timeout example in docs (GH-101499)Miss Islington (bot)2023-02-011-1/+1
| | | | | | Doc/library/asyncio-task.rstGH-timeout (cherry picked from commit 95fb0e02582b5673eff49694eb0dce1d7df52301) Co-authored-by: Raj <51259329+workingpayload@users.noreply.github.com>
* [3.11] gh-101454: fix documentation for END_ASYNC_FOR (#101455) (#101493)Irit Katriel2023-02-011-4/+3
| | | | | gh-101454: fix documentation for END_ASYNC_FOR (#101455) (cherry picked from commit 62251c3da06eb4662502295697f39730565b1717)
* gh-98657: [docs] `array.typecodes` is a module-level attribute (GH-98729)Miss Islington (bot)2023-02-011-3/+8
| | | | | | | | * gh-98657: [docs] `array.typecodes` is a module-level attribute * Update array.rst (cherry picked from commit c144e57b316e97a58ed5ad813c847fa8d2341dd7) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.11] gh-101440: fix json snippet error in logging-cookbook.rst (GH-101439) ↵Miss Islington (bot)2023-01-311-1/+1
| | | | | | | | | (GH-101463) (cherry picked from commit 20c11f2e600e1c0bf42de4d6f2fb3ce5ccc2587c) Co-authored-by: Peter Jiping Xie <peter.jp.xie@gmail.com> Automerge-Triggered-By: GH:hugovk
* gh-99276 - Updated Doc/faq/general.rst (GH-101396)Miss Islington (bot)2023-01-311-2/+2
| | | | | | (cherry picked from commit df0068ce4827471cc2962631ee64f6f38e818ec4) Co-authored-by: Raj <51259329+workingpayload@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Add JOBS parameter to docs Makefile (GH-101395)Miss Islington (bot)2023-01-311-1/+2
| | | | | (cherry picked from commit 1a62ae84c687791bc1dfb54d1eb75e1c7277bb04) Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
* gh-77607: Improve accuracy of os.path.join docs (GH-101406)Miss Islington (bot)2023-01-311-5/+5
| | | | | | | | | | | | | | This is a follow-up to GH-100811. One of the changes in that PR isn't accurate in that `os.path.join('', '')` will not end in a separator. This reverts that change to the previous wording that used "only", but explicitly calls out the case where the last part ends in a separator, which is what caused confusin in GH-77607 and motivated the change in GH-100811. (cherry picked from commit 909a6746939ea1d09fab21f26b558cfd7e3e29a0) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* Fixes typo in asyncio.TaskGroup context manager code example (GH-101449)Miss Islington (bot)2023-01-311-1/+1
| | | | | (cherry picked from commit ef09bf63d22b2efe5c0e9a2b9f25a9bec2ba1db0) Co-authored-by: Ben <22038077+bcla22@users.noreply.github.com>
* gh-101422: (docs) TarFile default errorlevel argument is 1, not 0 (GH-101424)Miss Islington (bot)2023-01-301-1/+1
| | | | | (cherry picked from commit ea232716d3de1675478db3a302629ba43194c967) Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
* gh-98240: Updated Path.rename docs, when it is atomic (GH-98245)Miss Islington (bot)2023-01-301-0/+2
| | | | | (cherry picked from commit 0023f51debeeeef483a6362ee12d67c4da086af3) Co-authored-by: Mateusz <mateka@users.noreply.github.com>
* Fix trivial typo in shebang example (GH-101385)Miss Islington (bot)2023-01-291-1/+1
| | | | | | The example was showing the current version, but should be pinned to 3.7 to match the example command. (cherry picked from commit 666c0840dcac9941fa41ec619fef8d45cd849a0b) Co-authored-by: socal-nerdtastic <37753609+socal-nerdtastic@users.noreply.github.com>
* [3.11] [doc] Add a section on logging handler configuration order. ↵Miss Islington (bot)2023-01-271-0/+23
| | | | | (GH-101380) (GH-101382) Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
* [3.11] [doc] Add some notices to logging configuration documentation. ↵Miss Islington (bot)2023-01-271-0/+10
| | | | | (GH-101373) (GH-101376) Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
* [docs] Mention how to get/set a bigint PyLong via the C API (GH-101270)Miss Islington (bot)2023-01-241-0/+4
| | | | | | | | | We don't need direct C APIs to get at a bigint representation of PyLong but we do want the few people who need to understand how. Additional Author: CAM-Gerlach (cherry picked from commit e244401ce508ad391295beb636e499fcc6797a2a) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* Added asyncio REPL example to docs. (GH-101243)Miss Islington (bot)2023-01-231-0/+12
| | | | | | (cherry picked from commit 5d868efde9ea08b39357b962a02a0294aa97689c) Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es> Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
* [3.11] GH-101097: Switch from standard interval notation to greater or less ↵Miss Islington (bot)2023-01-221-3/+3
| | | | | | | | | than signs for random.random()'s documentation (GH-101119) (GH-101246) (cherry picked from commit 8bcd4a6ec7f951d952c174c6a8d937cc62444738) Co-authored-by: Andrew Hong <andrewhong@myyahoo.com> Automerge-Triggered-By: GH:rhettinger
* [3.11] gh-86610: Use attribute directive in docs for pathlib.PurePath ↵Miss Islington (bot)2023-01-201-14/+14
| | | | | | | (GH-101114) (#101205) (cherry picked from commit 01093b82037fbae83623581294a0f1cf5b4a44b0) Co-authored-by: Barney Gale <barney.gale@gmail.com>
* [3.11] GH-101111: Disambigaute origin of const for store_const and ↵Miss Islington (bot)2023-01-201-3/+3
| | | | | | | | | | | | | append_const (GH-101121) (#101203) (cherry picked from commit 9a155138c58cad409e28e34359ba87ec0025b6b7) While the documentation for `optparse` mentioned that both `store_const` and `append_const` store a constant value, it was not clear where this value was coming from. A link to `Option.const` makes this explicit. Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>
* [3.11] Fix minor typos in SSL documentation (GH-101158) (#101201)Miss Islington (bot)2023-01-201-8/+8
| | | | | (cherry picked from commit 73497690b5debe01ba94ffefbecee034e39e8627) Co-authored-by: Simon Robinson <simon@robinson.ac>
* gh-91485: Avoid unnecessary use of non-Python syntax in io docs (GH-101177)Miss Islington (bot)2023-01-201-2/+2
| | | | | (cherry picked from commit 783d1bc51b886b6135e6a4effb91be207df5f50a) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* [3.11] gh-101100: [Enum] Fix sphinx warnings in docs (GH-101122) (#101173)Miss Islington (bot)2023-01-201-12/+12
| | | | | | (cherry picked from commit 9e025d305f159aebf01775ad1dc2817679f01aa9) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* [3.11] Provided better example for logging cookbook (GH-101164) (GH-101184)Miss Islington (bot)2023-01-201-10/+31
| | | | Co-authored-by: Vladimir Malinovskii <galqiwi@galqiwi.ru> Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
* [3.11] gh-101144: Allow zipfile.Path .open & .read_text encoding to be ↵Gregory P. Smith2023-01-201-0/+12
| | | | | | | | | | | positional (#101179) The zipfile.Path open() and read_text() encoding parameter can be supplied as a positional argument without causing a TypeError again. 3.10.0b1 included a regression that made it keyword only. Documentation update included as users writing code to be compatible with a wide range of versions will need to consider this for some time.. (cherry picked from commit 5927013e47a8c63b70e104152351f3447baa819c) Co-authored-by: Gregory P. Smith <greg@krypto.org> [Google]
* gh-101041: Fix a misspelled name of `utctimetuple` in a doc warning (GH-101042)Miss Islington (bot)2023-01-201-1/+1
| | | | | (cherry picked from commit 8e9d08b062bbabfe439bc73f82e3d7bb3800189e) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
* Docs: improve sqlite3 placeholders example (GH-101092)Miss Islington (bot)2023-01-181-13/+12
| | | | | (cherry picked from commit b84be8d9c0e6eca37be14c38250580251a3ef908) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* Fix typo in `ReprEnum` documentation (GH-101079)Miss Islington (bot)2023-01-171-1/+1
| | | | | (cherry picked from commit c5660ae96f2ab5732c68c301ce9a63009f432d93) Co-authored-by: Viicos <65306057+Viicos@users.noreply.github.com>
* gh-100247: Improve documentation for custom shebang commands in py.exe ↵Miss Islington (bot)2023-01-161-4/+5
| | | | | | | launcher (GH-101083) (cherry picked from commit 30753c37c6d00929af6afb5e0bc20bed4656d6b6) Co-authored-by: Steve Dower <steve.dower@python.org>
* [3.11] Sync-up parameter name in equivalent code snippet of `enumerate` ↵Miss Islington (bot)2023-01-151-2/+2
| | | | | | | | (GH-101029) (#101030) Sync-up parameter name in equivalent code snippet of `enumerate` (GH-101029) (cherry picked from commit ef633e5000222a3dba74473c49d6a81fca0a44ec) Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
* gh-100668: Clarify how sqlite3 maps parameters onto placeholders (GH-100960)Miss Islington (bot)2023-01-141-9/+17
| | | | | | (cherry picked from commit 206f05a46b426eb374f724f8e7cd42f2f9643bb8) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-101021: Document binary parameters as bytes (GH-101024)Miss Islington (bot)2023-01-141-5/+5
| | | | | (cherry picked from commit 49cae39ef020eaf242607bb2d2d193760b9855a6) Co-authored-by: Bob Kline <bkline@users.noreply.github.com>
* [3.11] Add recipes to showcase tee(), zip*, batched, starmap, and product. ↵Raymond Hettinger2023-01-141-24/+51
| | | | (GH-101028)
* gh-100247: Fix py.exe launcher not using entire shebang command for finding ↵Miss Islington (bot)2023-01-131-12/+27
| | | | | | | custom commands (GH-100944) (cherry picked from commit 468c3bf79890ef614764b4e7543608876c792794) Co-authored-by: Steve Dower <steve.dower@python.org>