summaryrefslogtreecommitdiffstats
path: root/Doc/library
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* 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-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>
* 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>
* [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>
* 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] 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>
* [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)
* [3.11] gh-100160: Tweak the documentation for the default asyncio policy ↵Serhiy Storchaka2023-01-131-3/+3
| | | | (GH-100969)
* Fix typo in `enum` module documentation (GH-100992)Miss Islington (bot)2023-01-121-1/+1
| | | | | (cherry picked from commit 2161bbf243983c625e8f24cdf43b757f2a21463b) Co-authored-by: Noam Cohen <noam@noam.me>
* GH-100894: Updated the doc for `sys.winver` to clarify its usual contents ↵Miss Islington (bot)2023-01-121-1/+1
| | | | | | | (GH-100913) (cherry picked from commit d9dff4c8b5ab41c47af002ad7fb083c953e75f31) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
* [3.11] gh-100160: Remove any deprecation warnings in ↵Serhiy Storchaka2023-01-102-11/+12
| | | | | | | asyncio.get_event_loop() (#100412) Some deprecation warnings will reappear (in a slightly different form) in 3.12. Co-authored-by: Guido van Rossum <guido@python.org>
* [3.11] Fix typos in Doc folder (GH-100880). (#100914)Hugo van Kemenade2023-01-101-1/+1
| | | Co-authored-by: Semen Zhydenko <semen.zhydenko@gmail.com>
* bpo-28356: Document os.rename() behavior on Windows for differing volumes ↵Miss Islington (bot)2023-01-091-0/+2
| | | | | | | (GH-27376) (cherry picked from commit e098137cd3250af05f19380590b8dec79dc5942f) Co-authored-by: Ryan Ozawa <ryan.ozawa21@gmail.com>
* gh-100783: fix os.path.join documentation (GH-100811)Miss Islington (bot)2023-01-081-11/+12
| | | | | | | | | - Use "drive", not "drive letter", because of UNC paths - Previous components are not thrown away from relative drive letters - Use "segment" instead of "component" for consistency with pathlib - Other miscellaneous improvements (cherry picked from commit 53455a319f3f2e5609fca2a313ea356fba318665) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* gh-100824: Fix typo in the documentation of ↵Miss Islington (bot)2023-01-081-2/+2
| | | | | | | unittest.TestLoader.testNamePatterns (GH-100825) (cherry picked from commit 6d3bc4a795e7a60f665e41b2d4b6803f3844fc48) Co-authored-by: busywhitespace <busywhitespace@tuta.io>
* [3.11] Future-proof recipe by renaming dotproduct() to sumprod() (GH-100828)Raymond Hettinger2023-01-071-4/+4
|
* gh-100673: Removed erroneous note in the get_type_hints docs (GH-100701)Miss Islington (bot)2023-01-071-4/+0
| | | | | | | | Removed erroneous note in the get_type_hints docs typing.get_type_hints still includes base class type hints. (cherry picked from commit deaf090699a7312cccb0637409f44de3f382389b) Co-authored-by: FrozenBob <30644137+FrozenBob@users.noreply.github.com>
* gh-99026 update dataclasses docs for when annotations are inspected (gh-100798)Miss Islington (bot)2023-01-061-2/+2
| | | | | | update dataclasses docs for when annotations are inspected (cherry picked from commit 659c2607f5b44a8a18a0840d1ac39df8a3219dd5) Co-authored-by: Akshit Tyagi <37214399+exitflynn@users.noreply.github.com>
* gh-87691: clarify use of anchor in pathlib docs (GH-100782)Miss Islington (bot)2023-01-061-8/+8
| | | | | | | | | | | | | | This is feedback from https://github.com/python/cpython/pull/100737GH-discussion_r1062968696 This matches the wording from the `os.path.join` docs better: https://docs.python.org/3/library/os.path.htmlGH-os.path.join In particular, the previous use of "anchor" was incorrect given the pathlib definition of "anchor". (cherry picked from commit 2f2fa03ff3d566b675020787e23de8fb4ca78e99) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com> Co-authored-by: Barney Gale <barney.gale@gmail.com>
* gh-87691: add an absolute path pathlib example in / operator docs (GH-100737)Miss Islington (bot)2023-01-051-1/+8
| | | | | | | The behaviour is fully explained a couple paragraphs above, but it may be useful to have a brief example to cover the behaviour. (cherry picked from commit 1ae619c911ec8e096f83eeb7cc57fcd966950a3d) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com> Automerge-Triggered-By: GH:hauntsaninja
* GH-100766: Note that locale.LC_MESSAGES is not universal (GH-100767)Miss Islington (bot)2023-01-051-0/+3
| | | Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
* [Enum] docs: replace 'last value' by 'highest value' for Flag auto (GH-100709)Miss Islington (bot)2023-01-031-3/+3
| | | | | (cherry picked from commit 64ed609c532a12b27f67a1e12e9e02f136ee3a94) Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
* gh-100428: Make int documentation more accurate (GH-100436)Miss Islington (bot)2023-01-021-11/+15
| | | | | | | | | | | | - Remove first link to lexical definition of integer literal, since it doesn't apply (differs in handling of leading zeros, base needs to be explicitly specified, unicode digits are allowed) - Better describe handling of leading zeros, unicode digits, underscores - Base 0 does not work exactly as like a code literal, since it allows Unicode digits. Link code literal to lexical definition of integer literal. (cherry picked from commit edfbf56f4ca6588dfd20b53f534a4465e43c82bd) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* gh-99953: Purge mention of numeric param style from sqlite3 docs (GH-100630)Miss Islington (bot)2023-01-011-5/+1
| | | | | | The PEP-249 numeric style has never been supported by sqlite3. (cherry picked from commit b7a68ab824249ebf053b8149ebb83cd8578781c9) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* gh-96773 Fix documentation of socket backlog (GH-96778)Miss Islington (bot)2023-01-011-2/+2
| | | | | (cherry picked from commit 1d1480fefc6ae77d14d6eff007b180ff5d1cd5d4) Co-authored-by: Mehrdad Moradizadeh <mhrddmoradii@gmail.com>
* gh-100546: Remove incorrect positional-only marker from eval (GH-100547)Miss Islington (bot)2023-01-011-1/+1
| | | | | | | | | All the arguments are positional-only. The current status after GH-99476 seems to be to not use positional-only markers in documentation, hence I've simply removed it. (cherry picked from commit 71159a8e078bda0c9a39c6cd0980b7ba238dc582) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* [3.11] Improve comments in itertools uniquification recipes (GH-100631) ↵Miss Islington (bot)2022-12-311-7/+12
| | | | (GH-100632)
* gh-100616: Document 'attr' parameter for window.vline() in curses module ↵Miss Islington (bot)2022-12-301-3/+3
| | | | | | | | (GH-24961) (cherry picked from commit f4fcfdf8c593611f98b9358cc0c5604c15306465) Co-authored-by: mathieui <mathieui@users.noreply.github.com> Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>