summaryrefslogtreecommitdiffstats
path: root/Doc/library
Commit message (Collapse)AuthorAgeFilesLines
* bpo-43705: Document that SyntaxError's offsets are 1-indexed (GH-25153)Miss Islington (bot)2021-04-021-3/+19
| | | | | | | | Changed the inline mentions of the attributes into a proper attribute list like `SystemExit` has. Automerge-Triggered-By: GH:gvanrossum (cherry picked from commit b2a91e0c9ee18b50cc86b21211c2258520a9f5d0) Co-authored-by: Ammar Askar <ammar@ammaraskar.com>
* Doc: io: Remove "In-memory streams" section (GH-24927)Miss Islington (bot)2021-04-011-10/+0
| | | | | (cherry picked from commit b045cdaf341f80b7d1e4804b932b6e415600c2e1) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* bpo-42840: Document providing kwargs to type. (GH-24173)Miss Islington (bot)2021-04-011-1/+8
| | | | | | Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com> (cherry picked from commit 72fcd14a82369ed32a5846d76f50e3026cf4eec2) Co-authored-by: Erik Soma <stillusingirc@gmail.com>
* bpo-42225: IDLE - document two unix-related problems. (GH-25078)Miss Islington (bot)2021-03-311-2/+17
| | | | | | | 1. Bad IP masquerade rules can prevent startup. 2. X cannot handle some complex colored chars. (cherry picked from commit 1b4a9c7956d5dc64f8002f62bf0faae2d1892f90) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-31907: [doc] clarify that str.format() does not support arbitrary ↵Miss Islington (bot)2021-03-281-2/+2
| | | | | | | | | expressions (GH-25053) (GH-25055) (cherry picked from commit fb1d01b9630b5069fe975f16e07a027d90b89434) Co-authored-by: Irit Katriel <iritkatriel@yahoo.com> Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
* bpo-43644: Add docs for importlib.resources.as_file. (GH-25048)Miss Islington (bot)2021-03-281-0/+16
| | | | | (cherry picked from commit af50c84643ce21cfbdfdabbdfae6bd5e1368c542) Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
* bpo-39616: clarify SSLContext.check_hostname effect (GH-18484)Miss Islington (bot)2021-03-271-1/+1
| | | | | | | | It doesn't actually affect whether match_hostname() is called (it never is in this context any longer), but whether hostname verification occurs in the first place. (cherry picked from commit 9798cef92b882cd82a338d3368eaf3c4a32f5c2d) Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
* bpo-43620: Remove reference to os.sep from os.path.join() doc (GH-25025) ↵Miss Islington (bot)2021-03-261-5/+4
| | | | | | | | (#25027) - removed ambiguous reference to os.sep from os.path.join() doc (cherry picked from commit 21a2cabb3795f5170c746ab8f29e9d25c7442550) Co-authored-by: Jared Sutton <jpsutton@gmail.com>
* Clarify attribute docs on types.ModuleType (GH-24974)Miss Islington (bot)2021-03-231-2/+30
| | | | | (cherry picked from commit 76b5d714e4e2b9f3b63847325cba51d4c4dc36bc) Co-authored-by: Brett Cannon <brett@python.org>
* Add a warning block around the get_referrers() documentation (GH-24511)Miss Islington (bot)2021-03-181-4/+5
| | | | | (cherry picked from commit 813db24f7c2c536d587d1832c3c52b44fa9e242e) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* [3.9] [doc] Document logging.basicConfig default format (GH-23710) (GH-24835)Miss Islington (bot)2021-03-151-1/+3
| | | (cherry picked from commit 35cacce5253c50eed0d285836f9ca0ac568991ca)
* Fix typos in unittest documentation (GH-24194)Miss Islington (bot)2021-03-141-3/+3
| | | | | | | * addCleanupClass -> addClassCleanup * doCleanupsClass -> doClassCleanups (cherry picked from commit e0e398ef1855f3db708c682f70adc412f0877d59) Co-authored-by: Conchylicultor <etiennefg.pot@gmail.com>
* Update link to Django's Context class. (GH-24805) (#24841)Miss Islington (bot)2021-03-132-2/+2
| | | | | | | * Update link to Django's Context class. * Update link to get-pip.py. (cherry picked from commit d0a445490e2c0e1d2aef3005f14211d9a85196bf) Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
* [3.9] bpo-43353: Document that logging.getLevelName() accepts string ↵Mariusz Felisiak2021-03-121-8/+17
| | | | | | | representation of logging level. (GH-24693) (GH-24826) (cherry picked from commit bbba28212ce0f58096a4043f32442c6e727b74fc) Automerge-Triggered-By: GH:vsajip
* [3.9] bpo-43439: Add audit hooks for gc functions (GH-24794). (GH-24811)Pablo Galindo2021-03-101-0/+5
| | | | | (cherry picked from commit b4f9089d4aa787c5b74134c98e5f0f11d9e63095) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* bpo-43446: Fix markup in sqlite3 footnote (GH-24806)Miss Islington (bot)2021-03-091-1/+1
| | | | | (cherry picked from commit 62a03cd490f81c0fb01eaceb31aa8a4c7800ed0e) Co-authored-by: Kamil Turek <kamil.turek@hotmail.com>
* bpo-43415: Fix typo on dataclasses.rst (GH-24789) (GH-24790)Miss Islington (bot)2021-03-081-1/+1
| | | | | | | (cherry picked from commit 0554044ddccdb7bf1fa4a8bc880e7a7b59f6479c) Co-authored-by: Guilherme Martins Crocetti <gmcrocetti@gmail.com> Co-authored-by: Guilherme Martins Crocetti <gmcrocetti@gmail.com>
* Put contextvars docs into the concurrency category (GH-24760)Miss Islington (bot)2021-03-062-1/+1
| | | | | (cherry picked from commit 5eb7796b7f3aae91b145ccea51b528662f3b5ce1) Co-authored-by: Brett Cannon <brett@python.org>
* bpo-43407: Clarify comparisons of time.monotonic() et al results (GH-24757)Miss Islington (bot)2021-03-061-4/+4
| | | | | | | Previous wording implied that only the result of call N and N+1 could be meaningfully compared, whereas comparing call N and N+M is fine. (cherry picked from commit ff5f05934db241dfafc604989b2de3487b09ca82) Co-authored-by: Alex Willmer <alex@moreati.org.uk>
* bpo-43400: Remove "easy to use" from mock docs (GH-24752) (GH-24758)Miss Islington (bot)2021-03-051-1/+1
|
* bpo-43396: Normalise naming in sqlite3 doc examples (GH-24746)Miss Islington (bot)2021-03-041-25/+25
| | | | | (cherry picked from commit 40d1b831ecd1b5b6a4fce9a908a6e61b50b360a0) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
* Add an attribution to the Green Tree Snakes in the AST docs (GH-24727)Miss Islington (bot)2021-03-031-0/+5
| | | | | (cherry picked from commit 62e3b6370cf9aa990485d9c7c3ea3f6f150daa47) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* Doc: Improve library/json document. (GH-24390)Miss Islington (bot)2021-03-021-7/+6
| | | | | (cherry picked from commit a347bc0b35c982e9600838d5a545e244bb76a4bf) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
* Fix grammar in enum documentation. (GH-24689)Miss Islington (bot)2021-03-011-1/+1
| | | | | | | | | There is an extra `s` in the singular word `method`. Reported in docs mailing list by Steven Nguyen. Automerge-Triggered-By: GH:Mariatta (cherry picked from commit f193874056fb185305084b79b32d2745ce9be7cf) Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
* bpo-43293: Doc: move note about GIL to top of threading module (GH-24622)Miss Islington (bot)2021-02-241-13/+13
| | | | | | | | | | | The note about the GIL was buried pretty deep in the threading documentation, and this made it hard for first time users to discover why their attempts at using threading to parallelizing their application did not work. In this commit, the note is moved to the top of the module documention for visibility. (cherry picked from commit 32181be6081f6c70a1e0bd0540050805c8e88e83) Co-authored-by: Guanzhong Chen <quantum2048@gmail.com>
* bpo-43283: Add IDLE doc paragraph about print speed (GH-24615)Miss Islington (bot)2021-02-241-0/+9
| | | | | | | | Printing to IDLE's Shell is often slower than printing to a system terminal, but it can be made faster by pre-formatting a single string before printing. (cherry picked from commit 2827e8a177c2a6584fada594bca6829c53a2872f) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-23882: Doc: Clarify unittest discovery document (GH-21560)Miss Islington (bot)2021-02-221-6/+12
| | | | | | | | | | | Unittest discovery support namespace package as start directory. But it doesn't find namespace package in the start directory automatically. Otherwise, unittest discovery search into unexpected directories like `vendor/` or `node_modules/`. (cherry picked from commit 5a4aa4c03e27ca5007b86c9c1ee62c77ad08a120) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* bpo-43283: Rearrange some IDLE doc paragraphs. (GH-24604)Miss Islington (bot)2021-02-211-14/+15
| | | | | | | In the Running User Code section, gather together paragraphs about two processes and the sys.stdstream replacements, preparing to add another. (cherry picked from commit 4cf7bb8e22bf37e6d65bf4cb5618d09c4a8ad612) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* Fix typo in dis module doc (GH-24509)Miss Islington (bot)2021-02-201-1/+1
| | | | | (cherry picked from commit 292f23186c6573bc1c3fa4f6e91116e8ee444cf4) Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
* [3.9] Minor improvements to the convolve() recipe (GH-24520)Pablo Galindo2021-02-151-2/+2
|
* [3.9] bpo-42967: only use '&' as a query string separator (GH-24297) (#24528)Senthil Kumaran2021-02-152-5/+25
| | | | | | | | | | | | | (cherry picked from commit fcbe0cb04d35189401c0c880ebfb4311e952d776) * [3.9] bpo-42967: only use '&' as a query string separator (GH-24297) bpo-42967: [security] Address a web cache-poisoning issue reported in urllib.parse.parse_qsl(). urllib.parse will only us "&" as query string separator by default instead of both ";" and "&" as allowed in earlier versions. An optional argument seperator with default value "&" is added to specify the separator. Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com> Co-authored-by: Adam Goldschmidt <adamgold7@gmail.com>
* bpo-43200: Fix link to shutil.copy() in the shutil doc (GH-24505)Miss Islington (bot)2021-02-131-2/+3
| | | | | | | Co-authored-by: Zackery Spytz <zspytz@gmail.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit 762fe7deed34a1d5294bf82071d318c8427b4893)
* bpo-41824: Add versionadded for typing.ForwardRef docs (#24224) (#24493)Ken Jin2021-02-091-0/+2
|
* bpo-16781: In 'exec' doc, add 'nonlocal' to 'yield' and 'return' (GH-2446)Miss Islington (bot)2021-02-071-1/+2
| | | | | | | | These 3 statements cannot be used at module scope -- nor in exec with one namespace. (cherry picked from commit 0ec57e25c918b859b9f8d464e34e0ac859c2f8b3) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-43059: Remove reference to legacy external sqlite3 repository (GH-24364)Miss Islington (bot)2021-01-311-4/+0
| | | | | (cherry picked from commit e60344364245a23a7a1b25d5ebce6833652a656c) Co-authored-by: L <3177243+LukeLR@users.noreply.github.com>
* Fixing typos in turtle.rst (GH-24376)Miss Islington (bot)2021-01-291-6/+6
| | | | | | Automerge-Triggered-By: GH:JulienPalard (cherry picked from commit 6baaae589d596ed3bb668448f2a22c5f62fc5fdf) Co-authored-by: Jules Lasne <jules.lasne@gmail.com>
* Fixed typo in turtle.rst (GH-24371)Miss Islington (bot)2021-01-291-1/+1
| | | | | | | | Found it while translating it to french 🤷 Automerge-Triggered-By: GH:JulienPalard (cherry picked from commit 6372a4ceba126aa0a9f00eee0f8023308f13e77b) Co-authored-by: Jules Lasne <jules.lasne@gmail.com>
* bpo-43008: Make IDLE respect sys.excepthook (GH-24302)Miss Islington (bot)2021-01-271-1/+1
| | | | | | Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit 7a34380ad788886f5ad50d4175ceb2d5715b8cff) Co-authored-by: Ken <kenny2minecraft@gmail.com>
* bpo-40304: Correct type(name, bases, dict) doc (GH-19553)Miss Islington (bot)2021-01-221-8/+9
| | | | | | | | Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com> (cherry picked from commit 644d52818a6391535e5838fd57d58ffcb1163056) Co-authored-by: Борис Верховский <boris.verk@gmail.com>
* [3.9] bpo-42811: Update importlib.utils.resolve_name() docs to use ↵Yair Frid2021-01-071-1/+1
| | | | | | | | __spec__.parent (GH-24100) (GH-24149) This is a backport of https://github.com/python/cpython/pull/24100 Automerge-Triggered-By: GH:brettcannon
* bpo-38413: Remove outdated section about multithreading in sqlite3 (GH-23159)Vladimir2021-01-061-13/+0
| | | (cherry picked from commit f9949f82e17c88609adb53eff3a7d5cd63a645bd)
* bpo-14014: Clarify StreamWriter.reset() documentation (GH-13716)Miss Islington (bot)2021-01-061-2/+2
| | | | | (cherry picked from commit 1a9f51ed12feb4d95ad6d0faf610a030c05b9f5e) Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
* Revert "[3.9] [doc] Fix erroneous backslashes in signatures and names ↵Julien Palard2021-01-048-10/+10
| | | | | | | | (GH-23658)" (GH-24092) This partially reverts commit e89993cff4e60fcf32643fc613d0544f3dbcd98a, which was removing backslashes in documentations compiled with Sphinx < 3, used for Python 3.8 and 3.9 docs.
* [3.9] bpo-42681: Fix range checks for color and pair numbers in curses ↵Serhiy Storchaka2021-01-031-6/+8
| | | | | | (GH-23874). (GH-24077) (cherry picked from commit 1470edd6131c29b8a09ce012cdfee3afa269d553)
* bpo-42781: Document the mechanics of cached_property from a user viewpoint ↵Miss Islington (bot)2021-01-011-4/+14
| | | | (GH-24031) (#24035)
* Fixes a typo in importlib.metadata. (GH-23921) (#24029)Miss Islington (bot)2020-12-311-2/+2
| | | | | | | | Signed-off-by: Tao He <sighingnow@gmail.com> (cherry picked from commit 3631d6deab064de0bb286ef2943885dca3c3075e) Co-authored-by: Tao He <sighingnow@gmail.com> Co-authored-by: Tao He <sighingnow@gmail.com>
* [3.9] bpo-41224: Add versionadded for Symbol.is_annotated (GH-23861). (GH-24017)Andre Delfino2020-12-311-0/+6
| | | | (cherry picked from commit 2edfc86f69d8a74f4821974678f664ff94a9dc22)
* bpo-42700: Swap descriptions in pyexpat.errors (GH-23876)Miss Islington (bot)2020-12-291-2/+2
| | | | | | | | | The descriptions of the `codes` and `messages` dictionaries in `xml.parsers.expat.errors` were swapped, and this commit swaps them back. For example, `codes` maps string descriptions of errors to numeric error codes, not the other way around. (cherry picked from commit 84402eb11086f97d31164aaa23e7238da3464f41) Co-authored-by: Michael Wayne Goodman <goodman.m.w@gmail.com>
* [doc] Fix missing commas in signatures (GH-23693)Miss Islington (bot)2020-12-292-3/+3
| | | | | | | | * Fix star in signatures * Fix comma in signatures (cherry picked from commit 60eccd095624f39195cc5ae0b49a59022bbbb028) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-42770: Fix a typo in the email.headerregistry docs (GH-23982)Miss Islington (bot)2020-12-291-1/+1
| | | | | | Automerge-Triggered-By: GH:zware (cherry picked from commit c56988b88fecf6dc70f039704fda6051a0754db1) Co-authored-by: Zackery Spytz <zspytz@gmail.com>