summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* gh-77771: Add enterabs example in sched (GH-92716)Miss Islington (bot)2022-12-241-5/+11
| | | | | | (cherry picked from commit 0f6420640c0f3462e6b76b01a392844676de1fb9) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* [3.10] Correct CVE-2020-10735 documentation (GH-100306). (#100477)Gregory P. Smith2022-12-241-3/+3
| | | | | (cherry picked from commit 1cf3d78c92eb07dc09d15cc2e773b0b1b9436825) Co-authored-by: Jeremy Paige <ucodery@gmail.com>
* gh-98712: Clarify "readonly bytes-like object" semantics in C arg-parsing ↵Miss Islington (bot)2022-12-231-19/+35
| | | | | | | docs (GH-98710) (cherry picked from commit 49f6ff719c4e0beeafd6c42edd696601acf72764) Co-authored-by: Petr Viktorin <encukou@gmail.com>
* gh-48496: Added example and link to faq for UnboundLocalError in reference ↵Miss Islington (bot)2022-12-222-0/+4
| | | | | | | (GH-93068) (cherry picked from commit f3db68e6e66ebb36e1b9cb30daba913ecc736169) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* gh-91081: Add note on WeakKeyDictionary behavior when deleting a replaced ↵Miss Islington (bot)2022-12-211-0/+24
| | | | | | | | | entry (GH-91499) (cherry picked from commit c615286e8576f2555d4380f38a966c300805b1a5) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Pieter Eendebak <P.T.eendebak@tudelft.nl> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-99991: improve docs on str.encode and bytes.decode (GH-100198)Miss Islington (bot)2022-12-211-27/+33
| | | | | | (cherry picked from commit a2bb3b7f9d8d15c81b724726454d68357fb31d1c) Co-authored-by: Bisola Olasehinde <horlasehinde@gmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* Clarify that every thread has its own default context in contextvars (GH-99246)Miss Islington (bot)2022-12-201-0/+5
| | | | | (cherry picked from commit cb60b6131bc2bb11c48a15f808914d8b242b9fc5) Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
* gh-69929: re docs: Add more specific definition of \w (GH-92015)Miss Islington (bot)2022-12-201-4/+3
| | | | | | (cherry picked from commit 36a0b1d0dddbdf324d98071ea31e7e9151eea6d5) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-97909: Fix markup for `PyMethodDef` members (GH-100089)Miss Islington (bot)2022-12-171-16/+17
| | | | | (cherry picked from commit 8edcb30c3f8bdd8099a093146fedbd9b63a3f667) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
* Document that zipfile's pwd parameter is a `bytes` object (GH-100209)Miss Islington (bot)2022-12-171-7/+8
| | | | | (cherry picked from commit 5ee7eb9debb12914f36c5ccee92460a681516fd6) Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
* gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302)Miss Islington (bot)2022-12-161-2/+4
| | | | | (cherry picked from commit 5234e1cbea686e38392f113707db322ad8405048) Co-authored-by: Ben Darnell <ben@bendarnell.com>
* "Compound statement" docs: Fix with-statement step indexing (GH-100286)Miss Islington (bot)2022-12-161-1/+1
| | | | | | | | Back in commit 226e6e7d4326cf91ef37e13528eb1f62de1bb832 an item was added to the list, renumbering all the rest of the items, but the forward-reference wasn't updated to match. (cherry picked from commit f23236a92d8796ae91772adaf27c3485fda963e8) Co-authored-by: Frank Dana <ferdnyc@gmail.com>
* GH-100206: use versionadded for the addition of sysconfig.get_default_scheme ↵Miss Islington (bot)2022-12-131-1/+1
| | | | | | | (GH-100207) (cherry picked from commit d3ea82aaf940167482df1e08d6482de8f2dd8526) Co-authored-by: Filipe Laíns <lains@riseup.net>
* Fix: typo (Indention) (GH-99904)Miss Islington (bot)2022-12-121-1/+1
| | | | | | | Example needed to be indented. Was trying to call a context manger `pr` (from ` with cProfile.Profile() as pr:`) wot perform ` pr.print_stats()` once it had already exited. (cherry picked from commit 8711b59f7ac1803307d340e357e025043fbe2f39) Co-authored-by: jarrodcolburn <jcourtlandcolburn@gmail.com> Automerge-Triggered-By: GH:AlexWaygood
* gh-70393: Clarify mention of "middle" scope (GH-98839)Miss Islington (bot)2022-12-121-2/+2
| | | | | (cherry picked from commit 70be5e42f6e288de32e0df3c77ac22a9ddf1a74b) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* gh-99728: correct typo in `datetime` format codes documentation (GH-99750)Miss Islington (bot)2022-12-101-1/+1
| | | | | (cherry picked from commit d5f8a2b6ad408368e728a389da918cead3ef7ee9) Co-authored-by: Brad Wolfe <brad.wolfe@gmail.com>
* gh-100049: fix `repr` for `mappingproxy` in dictionary view example doc ↵Miss Islington (bot)2022-12-101-1/+1
| | | | | | | (GH-100052) (cherry picked from commit 7c0fb71fbfa8682f56c15832e2c793a6180f2ec0) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
* gh-96250: Improve sqlite3 injection attack example (GH-99270)Miss Islington (bot)2022-12-081-6/+10
| | | | | | | (cherry picked from commit 41d4ac9da348ca33056e271d71588b2dc3a6d48d) Co-authored-by: Jia Junjie <62194633+jiajunjie@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* [3.10] gh-93453: Only emit deprecation warning in asyncio.get_event_loop ↵Łukasz Langa2022-12-063-9/+20
| | | | | | | | | | | when a new event loop is created (#100059) It no longer emits a deprecation warning if the current event loop was set. (cherry picked from commit 3fae04b10e2655a20a3aadb5e0d63e87206d0c67) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* [3.10] gh-100001: Remove doc typo, add versionadded (GH-100042) (#100044)Miss Islington (bot)2022-12-061-1/+3
| | | | | | (cherry picked from commit bed15f87eadc726122185cf41efcdda289f4a7b1) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* gh-100001: Omit control characters in http.server stderr logs. (GH-100002)Miss Islington (bot)2022-12-051-0/+7
| | | | | | Replace control characters in http.server.BaseHTTPRequestHandler.log_message with an escaped \xHH sequence to avoid causing problems for the terminal the output is printed to. (cherry picked from commit d8ab0a4dfa48f881b4ac9ab857d2e9de42f72828) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* [3.10] dataclasses.rst: Prevent horizontal scrolling (gh-100025). (gh-100029)Eric V. Smith2022-12-051-1/+2
| | | | | | | (cherry picked from commit 51ee0a29e9b20c3e4a94a675e73a894ee2fe447b) Co-authored-by: Ram Rachum <ram@rachum.com> Co-authored-by: Ram Rachum <ram@rachum.com>
* gh-85747: "Preface" section of asyncio-eventloop.rst: Switch to active voice ↵Miss Islington (bot)2022-12-041-7/+10
| | | | | | | and suggest other edits (GH-99784) (cherry picked from commit bf26bdf6ac04878fc720e78422991aaedb9808a1) Co-authored-by: Brian Skinn <brian.skinn@gmail.com>
* [3.10] GH-98906 ```re``` module: ```search() vs. match()``` section should ↵Miss Islington (bot)2022-11-301-6/+12
| | | | | | | | | | | | mention ```fullmatch()``` (GH-98916) (GH-99913) GH-98906 ```re``` module: ```search() vs. match()``` section should mention ```fullmatch()``` (GH-98916) Mention fullmatch along with search and match. (cherry picked from commit e0f91deb5930ecb02e7f8ced9bd82609e6889fb0) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com> Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
* Docs: improve accuracy of socketserver reference (GH-24767)Miss Islington (bot)2022-11-291-7/+3
| | | | | (cherry picked from commit 052bc128ac0bcafd36a0cbee5f4c2a10d74468dc) Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
* whatsnew-3.10: Mention PEP 647 in the Release highlights section. (GH-99853)Miss Islington (bot)2022-11-291-1/+2
| | | | | | | | Mention PEP 647 in the Release highlights section. Also re-ordered the list so it matches the order in the details sections below. (cherry picked from commit d74a58872c243bc766055d42f8280721629e3c82) Co-authored-by: Yilei "Dolee" Yang <yileiyang@google.com>
* gh-90717: Update the documentation for the altchars paremeter in base64 ↵Steve Dower2022-11-291-8/+11
| | | | | library (GH-94187) Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
* gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342)Miss Islington (bot)2022-11-281-6/+25
| | | | | | | | | | | | | | | | | | | | These slots are marked "should be treated as read-only" in the table at the start of the document. That doesn't say anything about setting them in the static struct. `tp_bases` docs did say that it should be ``NULL`` (TIL!). If you ignore that, seemingly nothing bad happens. However, some slots may not be inherited, depending on which sub-slot structs are present. (FWIW, NumPy sets tp_bases and is affected by the quirk -- though to be fair, its DUAL_INHERIT code probably predates tp_bases docs, and also the result happens to be benign.) This patch makes things explicit. It also makes the summary table legend easier to scan. (cherry picked from commit 219696abb240607d3f807853c4c180825e60716e) Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
* Docs: both sqlite3 "point examples" now adapt to str (GH-99823)Miss Islington (bot)2022-11-271-1/+1
| | | | | (cherry picked from commit 276643e207d44c53b87a8108d5b00982defcce1e) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* doc: Remove backslashes in doctest grammar docs (GH-29346)Miss Islington (bot)2022-11-271-3/+3
| | | | | (cherry picked from commit 22860dbbc8b53954055847d2bb036af68b4ea409) Co-authored-by: George Zhang <geetransit@gmail.com>
* bpo-43327: Fix the docs for PyImport_ImportFrozenModuleObject() (GH-24659)Miss Islington (bot)2022-11-271-2/+2
| | | | | | | | | The docs stated that PyImport_ImportFrozenModuleObject() returns a new reference, but it actually returns an int. (cherry picked from commit 62a5dc13e941d01beb215db4218a10977914ab55) Co-authored-by: Zackery Spytz <zspytz@gmail.com> Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
* [3.10] gh-99795: Fix typo in importlib.resources.abc (GH-99796) (GH-99800)Jason R. Coombs2022-11-261-1/+1
| | | | | | | | | | Changing TraversableReader to TraversableResources at one place of the documentation. See GH-99795 for more details.. (cherry picked from commit 5f8898216e7b67b7de6b0b1aad9277e88bcebfdb) Co-authored-by: busywhitespace <busywhitespace@tuta.io> Co-authored-by: busywhitespace <busywhitespace@tuta.io>
* [3.10] gh-99502: mention bytes-like objects as input in ↵Miss Islington (bot)2022-11-261-1/+3
| | | | | | | | | | | | | `secrets.compare_digest` (GH-99512) (#99790) gh-99502: mention bytes-like objects as input in `secrets.compare_digest` (GH-99512) Now it is in sync with https://docs.python.org/3/library/hmac.htmlGH-hmac.compare_digest It is the same function, just re-exported. So, I guess they should mention the same input types. (cherry picked from commit 47d673d81fc315069c14f9438ebe61fb70ef1ccc) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* Fix typo in `__match_args__` doc (GH-99785)Miss Islington (bot)2022-11-261-1/+1
| | | | | | A opy of GH-98549, whose author (@icecream17) uses a school computer that blocks the CLA site. I did not mention this in commit comment above so CLA bot does not pick up the name and request the CLA again. (cherry picked from commit a86d8545221b16e714ffe3bda5afafc1d4748d13) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* gh-96168: Add sqlite3 row factory how-to (GH-99507)Miss Islington (bot)2022-11-251-41/+119
| | | | | | | (cherry picked from commit 8749121b07f48994ea47f2e7ff75fb13c13953f6) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* Fix rendering of audioop license in Doc/license.rst (GH-99752)Miss Islington (bot)2022-11-241-0/+3
| | | | | | | Also some cosmetic blank line additions for consistency with the formatting of the rest of the file. (cherry picked from commit b5b3904f05e77f044f158307bc6bdd2bc1b670a2) Co-authored-by: Zachary Ware <zach@python.org>
* GH-92892: Add section about variadic functions to ctypes documentation ↵Miss Islington (bot)2022-11-221-0/+20
| | | | | | | | | | | (GH-99529) On some platforms, and in particular macOS/arm64, the calling convention for variadic arguments is different from the regular calling convention. Add a section to the documentation to document this. (cherry picked from commit bc3a11d21ddef28047b18c0f6a5068fa9fb16da2) Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
* [3.10] gh-99146 struct module documentation should have more predictable ↵Miss Islington (bot)2022-11-221-76/+206
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | examples/warnings (GH-99141) (GH-99703) gh-99146 struct module documentation should have more predictable examples/warnings (GH-99141) * nail down a couple examples to have more predictable output * update a number of things, but this is really just a stash... * added an applications section to describe typical uses for native and machine-independent formats * make sure all format strings use a format prefix character * responding to comments from @gpshead. Not likely finished yet. * This got more involved than I expected... * respond to several PR comments * a lot of wordsmithing * try and be more consistent in use of ``x`` vs ``'x'`` * expand examples a bit * update the "see also" to be more up-to-date * original examples relied on import * so present all examples as if * reformat based on @gpshead comment (missed before) * responding to comments * missed this * one more suggested edit * wordsmithing (cherry picked from commit 22d91c16bb03c3d87f53b5fee10325b876262a78) Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
* [3.10] GH-95815: Document less specific error for os.remove (GH-99571) (#99639)Miss Islington (bot)2022-11-211-1/+1
| | | | | | | | | | | | | GH-95815: Document less specific error for os.remove (GH-99571) os.remove can raise PermissionError instead of IsADirectoryError, when the object to be removed is a directory (in particular on macOS). This reverts a change done in GH-14262. (cherry picked from commit 1cae31d26ba621f6b1f0656ad3d69a0236338bad) Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
* [3.10] gh-85073: Add some missing links to source (GH-99363) (#99589)Stanley2022-11-198-0/+22
| | | | | (cherry picked from commit 27d8dc2c9d3de886a884f79f0621d4586c0e0f7a) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* Doc: Replace question mark with fullstop (GH-99558)Miss Islington (bot)2022-11-181-1/+1
| | | | | | | The sentence "Set the LC_CTYPE locale to the user preferred locale." should end with a period instead of a question mark. (cherry picked from commit 0e09d2cc59cad61ad6a7a79aade52e9a2cfa7b34) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.10] gh-92119: ctypes: Print exception class name instead of its ↵Kamil Turek2022-11-131-3/+3
| | | | | | | representation (GH-98302) (#99452) gh-92119: ctypes: Print exception class name instead of its representation (#98302) (cherry picked from commit b9dedfe61dce2997e3e6be318d8c50b0c19c9394)
* gh-99392: Fix sqlite3 converter recipes (GH-99393)Miss Islington (bot)2022-11-121-3/+22
| | | | | (cherry picked from commit dfc1b17a23fed933cffa09eec125a7e8c90ea867) Co-authored-by: naglis <827324+naglis@users.noreply.github.com>
* gh-87604: Clarify in docs that sys.addaudithook is not for sandboxes (GH-99372)Miss Islington (bot)2022-11-111-0/+9
| | | | | (cherry picked from commit c3c3871415c86088d45abcf73ccd2c2b09dc5772) Co-authored-by: Steve Dower <steve.dower@python.org>
* gh-98366: use sphinx.locale._ as gettext() in pyspecific.py (GH-98437)Miss Islington (bot)2022-11-111-4/+4
| | | | | | | | fix(doc-tools): use sphinx.locale._ as gettext() for backward-compatibility in pyspecific.py [why] spinix 5.3 changed locale.translators from a defaultdict(gettext.NullTranslations) to a dict, which leads to failure of pyspecific.py. Use sphinx.locale._ as gettext to fix the issue. (cherry picked from commit d26ee8a0a552de111b8245ef0de63e3f3f535d9f) Co-authored-by: Wei-Hsiang (Matt) Wang <mattwang44@gmail.com>
* GH-99183: Document behavior of count() for empty substrings (GH-99339)Miss Islington (bot)2022-11-101-0/+6
| | | | | (cherry picked from commit 2f4af2d99cffed6ba81e4b8fd886de6ae8625a3f) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* gh-99238: clarify the type of the env dict. (GH-99253)Miss Islington (bot)2022-11-081-3/+7
| | | | | (cherry picked from commit 2eee9d9cd7eb1e396fa9a4af7c5fadeeafbdaa38) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* Fix broken link in `asyncio-subprocesses` doc (GH-99214)Miss Islington (bot)2022-11-081-1/+1
| | | | | | | | | | | | | | | | | | | GH- Fix broken link in Doc/library/asyncio-subprocess.rst This is a trivial fix in documentation to fix a broken link. There is a broken link in [Doc/library/asyncio-subprocess.rst](https://docs.python.org/3/library/asyncio-subprocess.htmlGH-asyncio.subprocess.Process) for the function ``wait_for``: ![image](https://user-images.githubusercontent.com/37690409/200388894-fb6b7c42-b2cc-49ec-a239-e3472890db1f.png) I suppose this refers to the function ``asyncio.wait_for`` which is not clear in the docs. This PR fixes the link and the result looks like the following: ![image](https://user-images.githubusercontent.com/37690409/200389483-b4a92105-7d2c-4285-b0fc-78a6dc0be39c.png) (cherry picked from commit acf4d5d5bdecbc8756276731e09bae245d88518d) Co-authored-by: Mikael Koli <koli.mikael@gmail.com> Automerge-Triggered-By: GH:AlexWaygood
* [3.10] gh-96746: Docs: Clear up Py_TPFLAGS_DISALLOW_INSTANTIATION ↵Miss Islington (bot)2022-11-071-0/+11
| | | | | | | | | | | | inheritance (GH-99002) (GH-99213) gh-96746: Docs: Clear up Py_TPFLAGS_DISALLOW_INSTANTIATION inheritance (GH-99002) The flag is not inherited, but its effect -- a NULL tp_new -- is. Drop hints for people who come here wanting to “disallow instantiation”. (cherry picked from commit 1438b779971605e516bd0a4051a704d6ffbbd58d) Co-authored-by: Petr Viktorin <encukou@gmail.com>
* doc: Formatting and typo fixes (GH-98974)Miss Islington (bot)2022-11-073-10/+10
| | | | | (cherry picked from commit 728e42fcf51cbb2108caf1382df224c13b53d024) Co-authored-by: jmcb <joelsgp@protonmail.com>
generated by cgit v0.12 at 2025-03-20 14:16:16 (GMT)