summaryrefslogtreecommitdiffstats
path: root/Doc/library
Commit message (Collapse)AuthorAgeFilesLines
* Correctly document class instead of function (GH-32016)Miss Islington (bot)2022-03-231-4/+4
| | | | | (cherry picked from commit 624e3986fbf8467772e4863b7ec004e65adff619) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* [doc] configparser: avoid inline comments. (GH-31247)Miss Islington (bot)2022-03-231-2/+4
| | | | | | | | | People are testing those blocs with the default inline_comment_prefixes of None, leading to a: configparser.InterpolationSyntaxError: '$' must be followed by '$' or '{', found: '$ sign ($ is the only character that needs to be escaped)' (cherry picked from commit 3ac4e783e077ffd7b51c6acc1591002974644051) Co-authored-by: Julien Palard <julien@palard.fr>
* Fix typo in Path.iterdir docs (GH-31822)Miss Islington (bot)2022-03-231-1/+1
| | | | | (cherry picked from commit 795b365e8a6dfbeaa75780ed7807f8116f4537ca) Co-authored-by: Matt Williams <matt@milliams.com>
* [3.10] bpo-46769: Improve documentation for `typing.TypeVar` (GH-31712) ↵Alex Waygood2022-03-231-21/+88
| | | | | | | | | | (GH-31941) * [3.10] bpo-46769: Improve documentation for `typing.TypeVar` (GH-31712) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 81b425d4dc43b60dd11a3e9abc5c84a4b8b384db) * Remove references to `reveal_type`, add new section on `self` types
* [3.10] bpo-47061: document module deprecations due to PEP 594 (GH-31984) ↵Miss Islington (bot)2022-03-2226-22/+92
| | | | | | | | | | | (GH-32039) Also removed asynchat, asyncore, and smtpd from their respective toctree entries so they are only in the superceded subtree. (cherry picked from commit 9ac2de922a0f783bd43b8e026e4fb70fd1888572) Co-authored-by: Brett Cannon <brett@python.org> Automerge-Triggered-By: GH:brettcannon
* [3.10] bpo-47022: Document asynchat, asyncore and smtpd removals in 3.12 ↵Hugo van Kemenade2022-03-204-1/+10
| | | | | | | | (GH-31891) (#31997) Document the deprecation of asyncore, asynchat, and smtpd with a slated removal in Python 3.12 thanks to PEP 594.. (cherry picked from commit 77473846439b8a3eae66de1a1cfe931619f38513) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.10] bpo-47040: improve document of checksum functions (GH-31955) (GH-32002)Ma Lin2022-03-202-12/+9
| | | | | | | Clarifies a versionchanged note on crc32 & adler32 docs that the workaround is only needed for Python 2 and earlier. Also cleans up an unnecessary intermediate variable in the implementation. Authored-By: Ma Lin / animalize Co-authored-by: Gregory P. Smith <greg@krypto.org>
* bpo-44544: add textwrap placeholder arg (GH-27671)Miss Islington (bot)2022-03-191-2/+3
| | | | | (cherry picked from commit cb7874f49d3d55df73a3c529773af14e2e344fb7) Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
* [3.10] bpo-30677: [doc] mention that os.mkdir() can raise FileNotFoundError ↵Miss Islington (bot)2022-03-141-1/+2
| | | | | | | | | | (GH-31548) (GH-31877) (cherry picked from commit 879fbd9472753149b627f32add3ddca90ac47ab7) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com> Automerge-Triggered-By: GH:iritkatriel
* [3.10] bpo-43215: Document Happy Eyeballs args of asyncio.open_connection ↵Illia Volochii2022-03-141-1/+5
| | | | | | | | (GH-24525) (GH-31869) Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com> (cherry picked from commit 3543ddb4c4ebc26fb2d6c67a97e66f5267876f72) Co-authored-by: Illia Volochii <illia.volochii@gmail.com>
* [3.10] bpo-47004: Sync with importlib_metadata 4.11.3. (GH-31854). (GH-31857)Jason R. Coombs2022-03-131-0/+1
| | | | | (cherry picked from commit b1e286860742e7ba6fadc75e3ddb6c2899a56919) Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
* [3.10] sqlite3: normalise pre-acronym determiners (GH-31772) (GH-31806)Jelle Zijlstra2022-03-121-5/+5
| | | | | | | For consistency, replace "a SQL" with "an SQL".. (cherry picked from commit 2d5835a019a46573d5b1b614c8ef88d6b564d8d4) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
* [3.10] bpo-46677: Add examples of inheritance and attributes to `TypedDict` ↵Charlie Zhao2022-03-121-3/+88
| | | | | | | | docs (GH-31349) (GH-31815) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 8a207e0321db75f3342692905e342f1d5e1add54) Co-authored-by: Charlie Zhao <68189100+CharlieZhao95@users.noreply.github.com>
* bpo-31327: Update time documentation to reflect possible errors (GH-31460)Miss Islington (bot)2022-03-111-0/+6
| | | | | | | | | | | | | | | | | | As per the comments, this mirrors the [datetime documentation](https://docs.python.org/3/library/datetime.htmlGH-datetime.datetime.fromtimestamp). ``` >>> import time >>> time.localtime(999999999999999999999) Traceback (most recent call last): File "<stdin>", line 1, in <module> OverflowError: timestamp out of range for platform time_t >>> time.localtime(-3600) Traceback (most recent call last): File "<stdin>", line 1, in <module> OSError: [Errno 22] Invalid argument ``` (cherry picked from commit c83fc9c02c9846ec3a2d0123999c98e02f00b3f5) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* Remove print race from task_done example. (GH-31795)Miss Islington (bot)2022-03-101-4/+3
| | | | | (cherry picked from commit a0eb69c1a2e3aee75cb48e9868ef06a531b94a70) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* [3.10] Docstring: replace pysqlite with sqlite3 (GH-31758) (GH-31777)Jelle Zijlstra2022-03-091-2/+2
| | | | | | | Replace two instances of "pysqlite" with "sqlite3" in sqlite3 docstrings. Also reword "is a no-op" to "does nothing" for clarity.. (cherry picked from commit b33a1ae703338e09dc0af5fbfd8ffa01d3ff75da) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
* bpo-46494: Mention the typing_extensions pkg in typing docs (GH-31260)Miss Islington (bot)2022-03-081-0/+4
| | | | | (cherry picked from commit 8debeed3075bf4d7e568e65da16bec63cf276f4f) Co-authored-by: Meer Suri <46469858+meersuri@users.noreply.github.com>
* importlib.metadata: Remove empty footnote section (GH-30451)Miss Islington (bot)2022-03-081-3/+0
| | | | | (cherry picked from commit 13331a12c3c4d5007e2ab61514ba1d76cedd8b84) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* bpo-38738: Fix formatting of True and False in the threading documentation ↵Miss Islington (bot)2022-03-041-8/+8
| | | | | | | | | (GH-31678) * Fix formatting of True and False in the threading documentation * Update threading.rst (cherry picked from commit 46a116c1c9f6b60a3d35ab9a419f8eee5de2542e) Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
* bpo-25415: Remove confusing sentence from IOBase docstrings (PR-31631)Miss Islington (bot)2022-03-041-7/+4
| | | | | (cherry picked from commit cedd2473a9bebe07f3ced4f341cf58a2fef07b03) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* bpo-6634: [doc] clarify that sys.exit() does not always exit the interpreter ↵Miss Islington (bot)2022-03-031-5/+3
| | | | | | | (GH-31639) (cherry picked from commit 10117f1d8cb49ce95493555c06050faf636ccee7) Co-authored-by: vidhya <96202776+Vidhyavinu@users.noreply.github.com>
* bpo-21910: Clarify docs for codecs writelines method (GH-31245)Miss Islington (bot)2022-03-031-2/+3
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit a8c87a239ee1414d6dd0b062fe9ec3e5b0c50cb8) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* [3.10] bpo-45492: Corrected documentation for co_names in inspect library ↵Irit Katriel2022-03-021-2/+3
| | | | | | | | | doc (GH-31456). (GH-31645) (cherry picked from commit 3257d49d236e5f3453fe9d2fd8338bcdfe9756b7) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com> Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* bpo-42982: update pbkdf2 example & add another link (GH-30966) (#30968)Miss Islington (bot)2022-03-011-5/+7
| | | | | | | Automerge-Triggered-By: GH:gpshead (cherry picked from commit ace0aa2a2793ba4a2b03e56c4ec375c5470edee8) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* bpo-26897: Clarify Popen stdin, stdout, stderr file object docs (GH-30231)Miss Islington (bot)2022-02-251-14/+16
| | | | | (cherry picked from commit dd69f734218ac5d3a551227069ac53ee09b0cd3e) Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
* Update dict/OrderedDict differences with code equivalents. (GH-31563)Miss Islington (bot)2022-02-251-6/+23
| | | | | (cherry picked from commit 26aba295a9c1bcb0812fe44bd7e68ddd1d8a6828) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* bpo-34429: Noted TemporaryFile behavior on non-Posix/non-Cygwin systems ↵Miss Islington (bot)2022-02-251-0/+3
| | | | | | | (GH-31547) (cherry picked from commit 53ecf9e08d35801807daf74492c090a325f995b7) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* [3.10] bpo-20923 : [doc] Explain ConfigParser 'valid section name' and ↵Miss Islington (bot)2022-02-221-0/+3
| | | | | | | | | | .SECTCRE (GH-31413) (GH-31506) (cherry picked from commit bba8008f99d615a02984422a3825082bb5621f5a) Co-authored-by: vidhya <96202776+Vidhyavinu@users.noreply.github.com> Automerge-Triggered-By: GH:iritkatriel
* [docs] Correct typos in SSLContext.sni_callback (GH-30623) (GH-31421)Miss Islington (bot)2022-02-211-3/+3
| | | | | | Co-authored-by: Jörn Heissler <nosuchaddress@joern-heissler.de> (cherry picked from commit f80a97b492f41afd3c42bb2bd6da7b2828dca215) Co-authored-by: Jörn Heissler <joernheissler@users.noreply.github.com>
* Counter doc mentions three methods, but lists four (GH-30706)Miss Islington (bot)2022-02-191-1/+1
| | | | | | Was probably caused by the addition of the `total()` method (cherry picked from commit 99331fcf175b03b6b82451ac9aa953b476ab48e0) Co-authored-by: Charles Brunet <charles.brunet@optelgroup.com>
* bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388)Miss Islington (bot)2022-02-187-181/+82
| | | | | (cherry picked from commit 2923d87ca258b9d421e8147b12f0d98295ee3f8e) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.10] Update html.parser.rst (GH-30678) (GH-31385)Miss Islington (bot)2022-02-171-1/+1
| | | | | | | | | | | | This PR for the documentation of the [html.parser](https://docs.python.org/3/library/html.parser.html) module will - fix a terminology mistake (‘start of a tag’ -> ‘start tag of an element’); - mention the parameter names of the `HTMLParser.handle_*` methods where missing. (cherry picked from commit 2945f5a7c51200bfc5c493ccb626fc414e1385b1) Co-authored-by: Géry Ogam <gery.ogam@gmail.com> Automerge-Triggered-By: GH:merwok
* Update the OMG link (GH-30383)Miss Islington (bot)2022-02-151-1/+1
| | | | | | | (cherry picked from commit 04215a427232e55efdc1adcda50a15197f518ca9) Co-authored-by: David Gilbertson <gilbertson.david@gmail.com> Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
* Fix the signature of multiprocessing.set_executable (GH-31276) Miss Islington (bot)2022-02-141-2/+2
| | | | | | | | Automerge-Triggered-By: GH:merwok (cherry picked from commit 4f9386661d51b78348395e78710f3bfbee9fd1de) Co-authored-by: Géry Ogam <gery.ogam@gmail.com> Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
* Update __main__.rst (GH-30896) Miss Islington (bot)2022-02-141-1/+1
| | | | | | | | | The reference to `venv` appears in the paragraph below, instead of above. Fixed the documentation. (cherry picked from commit 4e4e7c2684b80350e82d82e4feeda5de24d362b9) Co-authored-by: David Gilbertson <gilbertson.david@gmail.com> Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
* doc: use colon for all color's rangs (GH-28998) (#31336)Miss Islington (bot)2022-02-141-2/+2
| | | | | | | (cherry picked from commit 6b9f27dd0b5da53b1fd648494879d857572bec80) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com> Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* bpo-38619: Update the documentation for UUID.hex (GH-29830)Miss Islington (bot)2022-02-141-1/+1
| | | | | | | | Explicitly state that it is lowercase. Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com> (cherry picked from commit 5d53cf30f9cb3758849e859db5d4602cb7c521f7) Co-authored-by: 180909 <wjh180909@gmail.com>
* [3.10] bpo-46747: Add missing key parameters in the bisect docs (GH-31323) ↵Dennis Sweeney2022-02-141-2/+2
| | | | | | | | (GH-31329) Added *key* parameter to `bisect.bisect()` and `bisect.insort()` in bisect module docs. (cherry picked from commit 96084f4256d2d523b0a4d7d900322b032326e3ed) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* Corrections to format precision description. (GH-31291)Miss Islington (bot)2022-02-141-5/+6
| | | | | | | | | | | | | | * `precision` field is a decimal integer * clarify that stated limitations are on presentation type rather than input value type. Especially misleading is "precision is not allowed for integer values", since integer value input to a format like `.1f` is fine. * regarding max field size, replace "non-number" with "string", which is the only non-numeric presentation type Automerge-Triggered-By: GH:ericvsmith (cherry picked from commit 1d6ce67c29aa2166ef326952cb605b908fb4f987) Co-authored-by: John Belmonte <john@neggie.net>
* bpo-46483: [doc] pathlib classes no longer support parameterized generics ↵Miss Islington (bot)2022-02-111-4/+0
| | | | | | | | | (GH-31281) Remove pathlib classes from the list in stdtypes.rst of classes that can be parameterized at runtime. (cherry picked from commit e0bc8ee945af96f9395659bbe3cc30b082e7a361) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* bpo-43532: add version added to KW_ONLY (GH-31235)Miss Islington (bot)2022-02-091-0/+2
| | | | | | | | Minor missing version note mentioned at the end of (and affected me independently before reading that note). Automerge-Triggered-By: GH:ericvsmith (cherry picked from commit 5a3f97291eea96037cceee097ebc00bba44bc9ed) Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com>
* [3.10] bpo-46609: Update asyncio-task coroutine doc (GH-31132)Terry Jan Reedy2022-02-041-1/+1
| | | @coroutine in removed in 3.11, not 3.10.
* Optimize images by IMGbot (GH-21348)Miss Islington (bot)2022-02-043-1/+1
| | | | Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com> (cherry picked from commit ba650af7d660084e08859dd1ee1917cccee24e88)
* Add recipe for subslices (GH-31095)Raymond Hettinger2022-02-031-0/+6
|
* Fix minor details in the Counter docs (GH-31029) (GH-31072)Miss Islington (bot)2022-02-021-3/+10
|
* [3.10] bpo-23556: [doc] Fix inaccuracy in documentation for raise without ↵Miss Islington (bot)2022-01-271-9/+8
| | | | | | | | | | args. Improve tests for context in nested except handlers. (GH-29236) (GH-30953) (cherry picked from commit 08c0ed2d9c0d01ad1a5adc0787bc75e4e90cbb85) Co-authored-by: Kinshuk Dua <kinshukdua@gmail.com> Automerge-Triggered-By: GH:iritkatriel
* bpo-42982: Improve the text on suggested number of iterations of PBKDF2 ↵Miss Islington (bot)2022-01-271-2/+7
| | | | | | | | | | (GH-24276) Less specific number wording (as there is no one right number - the old 100k is too big for some applications and woefully small for others). We now link to NIST SP 800-132 to tell people what to read in there on how to decide for their application. Co-authored-by: Gregory P. Smith <greg@krypto.org> [Google] (cherry picked from commit 897ce9018775bcd679fb49aa17258f8f6e818e23) Co-authored-by: Illia Volochii <illia.volochii@gmail.com>
* bpo-45296: Clarify close, quit, and exit in IDLE (GH-30936) (GH-30944)Miss Islington (bot)2022-01-271-4/+6
| | | | | | | | | | | In the File menu, 'Close' and 'Exit' are now 'Close Window' (the current one) and 'Exit' is now 'Exit IDLE' (by closing all windows). In Shell, 'quit()' and 'exit()' mean 'close Shell'. If there are no other windows, this also exits IDLE. (cherry picked from commit fcde0bc10ddd836b62d0a8e893d80b8c55e0ba3f) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-43698: do not use `...` as argument name in docs (GH-30502)Miss Islington (bot)2022-01-262-6/+6
| | | | | (cherry picked from commit b9d8980d89bfaa4bf16d60f0488adcc9d2cbf5ef) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* Improve grouper() recipe to demonstrate all forms of zip() (GH-30837) (GH-30840)Miss Islington (bot)2022-01-231-3/+12
|
generated by cgit v0.12 at 2026-01-10 12:47:23 (GMT)