summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
...
* gh-101992: update plistlib examples to be runnable (GH-101994)Miss Islington (bot)2023-02-171-6/+15
| | | | | | | | | | | | * gh-101992: update plistlib examples to be runnable * Update Doc/library/plistlib.rst --------- (cherry picked from commit a1723caabfcdca5d675c4cb04554fb04c7edf601) Co-authored-by: Dustin Rodrigues <dust.rod@gmail.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* gh-101973: Fix parameter reference for PyModule_FromDefAndSpec (GH-101976)Miss Islington (bot)2023-02-171-2/+2
| | | | | (cherry picked from commit a3bb7fbe7eecfae6bf7b2f0912f9b2b12fac8db1) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
* gh-93573: Replace wrong example domains in configparser doc (GH-93574)Miss Islington (bot)2023-02-161-23/+23
| | | | | | | | | | * Replace bitbucket.org domain by forge.example * Update example to python.org * Use explicitly invalid domain topsecret.server.com domain is not controled by PSF. It's replaced by invalid topsecret.server.example domain. It follows RFC 2606, which advise .example as TLD for documentation. (cherry picked from commit 924a3bfa28578802eb9ca77a66fb5d4762a62f14) Co-authored-by: sblondon <stephane.blondon@gmail.com>
* GH-101898: Fix missing term references for hashable definition (GH-101899)Miss Islington (bot)2023-02-1416-22/+22
| | | | | | Fix missing term references for hashable definition (cherry picked from commit 3690688149dca11589af59b7704541336613199a) Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
* 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>
* [3.10] 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-101814) 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>
* Docs: Fix getstatus() -> getcode() typos (GH-101296)Miss Islington (bot)2023-02-102-2/+2
| | | | | (cherry picked from commit 61f2be08661949e2f6dfc94143436297e60d47de) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.10] Docs: use parameter list for sqlite3.Cursor.execute* (GH-101782) ↵Erlend E. Aasland2023-02-101-12/+35
| | | | | | | (#101808) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 2037ebf81bd4bbe5421421b822bd57cfd665a1e9)
* Apply suggestions from code reviewMiss Islington (bot)2023-02-081-0/+40
|
* [3.10] gh-47937: Note that Popen attributes are read-only (GH-93070) (#101683)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.10] gh-97725: Fix documentation for the default file of ↵Oleg Iarygin2023-02-081-1/+1
| | | | | `asyncio.Task.print_stack` (#101652) (#101654) (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>
* 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: 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-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-101440: fix json snippet error in logging-cookbook.rst (GH-101439)Miss Islington (bot)2023-01-311-1/+1
| | | | | (cherry picked from commit 20c11f2e600e1c0bf42de4d6f2fb3ce5ccc2587c) Co-authored-by: Peter Jiping Xie <peter.jp.xie@gmail.com>
* [3.10] gh-99276 - Updated Doc/faq/general.rst (GH-101396) (#101462)Miss Islington (bot)2023-01-311-2/+2
| | | | 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>
* 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.10] [doc] Add a section on logging handler configuration order. ↵Miss Islington (bot)2023-01-271-0/+23
| | | | | (GH-101380) (GH-101381) Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
* [3.10] [doc] Add some notices to logging configuration documentation. ↵Miss Islington (bot)2023-01-271-0/+10
| | | | | (GH-101373) (GH-101375) 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>
* [3.10] Added asyncio REPL example to docs. (GH-101243) (#101257)Kumar Aditya2023-01-231-0/+11
| | | | | | (cherry picked from commit 5d868efde9ea08b39357b962a02a0294aa97689c) Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com> Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
* [3.10] gh-86610: Use attribute directive in docs for pathlib.PurePath ↵Miss Islington (bot)2023-01-201-14/+14
| | | | | | | (GH-101114) (#101206) (cherry picked from commit 01093b82037fbae83623581294a0f1cf5b4a44b0) Co-authored-by: Barney Gale <barney.gale@gmail.com>
* [3.10] GH-101111: Disambigaute origin of const for store_const and ↵Miss Islington (bot)2023-01-201-3/+3
| | | | | | | | | | | | | append_const (GH-101121) (#101204) (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.10] Fix minor typos in SSL documentation (GH-101158) (#101202)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.10] Provided better example for logging cookbook (GH-101164) (GH-101183)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.10] gh-101144: Allow zipfile.Path .open & .read_text encoding to be ↵Miss Islington (bot)2023-01-201-0/+12
| | | | | | | | | | | | | | positional (GH-101179) (GH-101182) 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) (cherry picked from commit efe3a389cabd7295e6e0938767cdc4055c871e3c) Co-authored-by: Gregory P. Smith <greg@krypto.org> [Google] Automerge-Triggered-By: GH:gpshead
* 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>
* [3.10] gh-101021: Document binary parameters as bytes (GH-101024). (#101052)Barry Warsaw2023-01-151-5/+5
| | | | | | | (cherry picked from commit 49cae39ef020eaf242607bb2d2d193760b9855a6) Co-authored-by: Bob Kline <bkline@users.noreply.github.com> Co-authored-by: Bob Kline <bkline@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>
* [3.10] gh-100160: Remove any deprecation warnings in ↵Serhiy Storchaka2023-01-133-25/+13
| | | | | | | | | asyncio.get_event_loop() (GH-100412) (GH-100970) Some deprecation warnings will reappear (in a slightly different form) in 3.12. Co-authored-by: Guido van Rossum <guido@python.org>. (cherry picked from commit 1b2459dc64b1c3eea89312ea9bf422f8d7c75bb2)
* 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.10] gh-100916: Convert argument to appropriate type (GH-100917) (GH-100919)Miss Islington (bot)2023-01-101-1/+1
| | | Co-authored-by: Yao-Ching Huang <tom4996131207@gmail.com>
* [3.10] Fix typos in Doc folder (GH-100880). (#100915)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>
* [3.10] Update copyright years to 2023. (gh-100850)Benjamin Peterson2023-01-082-2/+2
| | | | | | | | | | * [3.10] Update copyright years to 2023. (gh-100848). (cherry picked from commit 11f99323c2ae0ec428c370a335695e3d8d4afc1d) Co-authored-by: Benjamin Peterson <benjamin@python.org> * Update additional copyright years to 2023. Co-authored-by: Ned Deily <nad@python.org>
* 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.10] gh-100673: Removed erroneous note in the get_type_hints docs ↵Alex Waygood2023-01-071-4/+0
| | | | | | | | | | | (#100701) (GH-100826) Removed erroneous note in the get_type_hints docs typing.get_type_hints still includes base class type hints. (cherry picked from commit deaf090699a7312cccb0637409f44de3f382389b) Automerge-Triggered-By: GH:AlexWaygood
* 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>
generated by cgit v0.12 at 2025-04-14 13:20:15 (GMT)