Commit Graph

11045 Commits

Author SHA1 Message Date
Miss Islington (bot) bdce188036
bpo-25415: Remove confusing sentence from IOBase docstrings (PR-31631)
(cherry picked from commit cedd2473a9)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-03-04 10:33:57 -08:00
Miss Islington (bot) 9d9dc59d07
bpo-6634: [doc] clarify that sys.exit() does not always exit the interpreter (GH-31639)
(cherry picked from commit 10117f1d8c)

Co-authored-by: vidhya <96202776+Vidhyavinu@users.noreply.github.com>
2022-03-03 06:49:22 -08:00
Miss Islington (bot) 60b561c246
bpo-21910: Clarify docs for codecs writelines method (GH-31245)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit a8c87a239e)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-03-02 17:43:00 -08:00
Irit Katriel eb65e46b9b
[3.10] bpo-45492: Corrected documentation for co_names in inspect library doc (GH-31456). (GH-31645)
(cherry picked from commit 3257d49d23)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-03-02 19:37:17 +00:00
Miss Islington (bot) 7dbb2f8eaf
bpo-42982: update pbkdf2 example & add another link (GH-30966) (#30968)
Automerge-Triggered-By: GH:gpshead
(cherry picked from commit ace0aa2a27)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-03-01 15:56:25 -05:00
Miss Islington (bot) 1f956d11db
bpo-26897: Clarify Popen stdin, stdout, stderr file object docs (GH-30231)
(cherry picked from commit dd69f73421)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-02-25 09:03:37 -08:00
Miss Islington (bot) 8b37a0c522
Update dict/OrderedDict differences with code equivalents. (GH-31563)
(cherry picked from commit 26aba295a9)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-02-25 07:15:58 -08:00
Miss Islington (bot) 632a8121d4
bpo-34429: Noted TemporaryFile behavior on non-Posix/non-Cygwin systems (GH-31547)
(cherry picked from commit 53ecf9e08d)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-02-25 03:30:31 -08:00
Miss Islington (bot) a7af34d407
[3.10] bpo-20923 : [doc] Explain ConfigParser 'valid section name' and .SECTCRE (GH-31413) (GH-31506)
(cherry picked from commit bba8008f99)


Co-authored-by: vidhya <96202776+Vidhyavinu@users.noreply.github.com>

Automerge-Triggered-By: GH:iritkatriel
2022-02-22 10:28:34 -08:00
Miss Islington (bot) a2e13ec0ce
[docs] Correct typos in SSLContext.sni_callback (GH-30623) (GH-31421)
Co-authored-by: Jörn Heissler <nosuchaddress@joern-heissler.de>
(cherry picked from commit f80a97b492)

Co-authored-by: Jörn Heissler <joernheissler@users.noreply.github.com>
2022-02-20 16:17:56 -08:00
Miss Islington (bot) 75c5dbc27e
Counter doc mentions three methods, but lists four (GH-30706)
Was probably caused by the addition of the `total()` method
(cherry picked from commit 99331fcf17)

Co-authored-by: Charles Brunet <charles.brunet@optelgroup.com>
2022-02-18 18:45:56 -08:00
Miss Islington (bot) 6eb34772fd
bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388)
(cherry picked from commit 2923d87ca2)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-02-18 01:30:36 -08:00
Miss Islington (bot) 68e80c4e74
[3.10] Update html.parser.rst (GH-30678) (GH-31385)
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 2945f5a7c5)


Co-authored-by: Géry Ogam <gery.ogam@gmail.com>

Automerge-Triggered-By: GH:merwok
2022-02-17 04:41:07 -08:00
Miss Islington (bot) 5b63ba3ff5
Update the OMG link (GH-30383)
(cherry picked from commit 04215a4272)

Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>

Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
2022-02-15 09:17:00 -08:00
Miss Islington (bot) 543242ad8c
Fix the signature of multiprocessing.set_executable (GH-31276)
Automerge-Triggered-By: GH:merwok
(cherry picked from commit 4f9386661d)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-02-14 12:11:02 -08:00
Miss Islington (bot) a414cb35c2
Update __main__.rst (GH-30896)
The reference to `venv` appears in the paragraph below, instead of above.
Fixed the documentation.
(cherry picked from commit 4e4e7c2684)

Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>

Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
2022-02-14 12:10:34 -08:00
Miss Islington (bot) c5a987bf4d
doc: use colon for all color's rangs (GH-28998) (#31336)
(cherry picked from commit 6b9f27dd0b)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2022-02-14 12:10:05 -08:00
Miss Islington (bot) 828253227e
bpo-38619: Update the documentation for UUID.hex (GH-29830)
Explicitly state that it is lowercase.

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
(cherry picked from commit 5d53cf30f9)

Co-authored-by: 180909 <wjh180909@gmail.com>
2022-02-14 11:20:48 -08:00
Dennis Sweeney 841c77d802
[3.10] bpo-46747: Add missing key parameters in the bisect docs (GH-31323) (GH-31329)
Added *key* parameter to `bisect.bisect()` and `bisect.insort()` in bisect module docs.
(cherry picked from commit 96084f4256)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2022-02-14 11:51:16 -05:00
Miss Islington (bot) 6a7dd3f9e9
Corrections to format precision description. (GH-31291)
* `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 1d6ce67c29)

Co-authored-by: John Belmonte <john@neggie.net>
2022-02-13 16:21:32 -08:00
Miss Islington (bot) f2fbfbe0ec
bpo-46483: [doc] pathlib classes no longer support parameterized generics (GH-31281)
Remove pathlib classes from the list in stdtypes.rst of classes
that can be parameterized at runtime.
(cherry picked from commit e0bc8ee945)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-02-11 13:04:01 -08:00
Miss Islington (bot) 7445949a43
bpo-43532: add version added to KW_ONLY (GH-31235)
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 5a3f97291e)

Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com>
2022-02-09 13:18:52 -08:00
Terry Jan Reedy 5603db43ba
[3.10] bpo-46609: Update asyncio-task coroutine doc (GH-31132)
@coroutine in removed in 3.11, not 3.10.
2022-02-04 14:59:23 -05:00
Miss Islington (bot) 34895f694c
Optimize images by IMGbot (GH-21348)
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
(cherry picked from commit ba650af7d6)
2022-02-04 16:31:21 +09:00
Raymond Hettinger a77de58108
Add recipe for subslices (GH-31095) 2022-02-03 02:12:08 -06:00
Miss Islington (bot) e480def027
Fix minor details in the Counter docs (GH-31029) (GH-31072) 2022-02-01 23:28:07 -06:00
Miss Islington (bot) 2572c670d4
[3.10] bpo-23556: [doc] Fix inaccuracy in documentation for raise without args. Improve tests for context in nested except handlers. (GH-29236) (GH-30953)
(cherry picked from commit 08c0ed2d9c)


Co-authored-by: Kinshuk Dua <kinshukdua@gmail.com>

Automerge-Triggered-By: GH:iritkatriel
2022-01-27 02:51:06 -08:00
Miss Islington (bot) 1ecc98dedb
bpo-42982: Improve the text on suggested number of iterations of PBKDF2 (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 897ce90187)

Co-authored-by: Illia Volochii <illia.volochii@gmail.com>
2022-01-27 01:01:30 -08:00
Miss Islington (bot) 5acaad0b30
bpo-45296: Clarify close, quit, and exit in IDLE (GH-30936) (GH-30944)
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 fcde0bc10d)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-01-26 22:55:25 -05:00
Miss Islington (bot) a57ec7a4fe
bpo-43698: do not use `...` as argument name in docs (GH-30502)
(cherry picked from commit b9d8980d89)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-01-26 04:42:26 -08:00
Miss Islington (bot) b2c7fe1f61
Improve grouper() recipe to demonstrate all forms of zip() (GH-30837) (GH-30840) 2022-01-23 16:02:31 -06:00
Miss Islington (bot) f66ef3eab6
bpo-46266: Add calendar day of week constants to __all__ (GH-30412) (GH-30424)
(cherry picked from commit e5894ca8fd)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-01-23 02:00:11 +01:00
Miss Islington (bot) 923c994400
bpo-46468: document that "-m http.server" defaults to port 8000 (GH-30776) (#30787)
Code link:
70c16468de/Lib/http/server.pyGH-L1270

It's been this way since at least 3.4.

Also improved some wording in the same section.
(cherry picked from commit c8a536624e)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-01-22 17:31:52 +02:00
Miss Islington (bot) ee07750088
doc: Clarify os.urandom return type (GH-30282)
Other descriptions in the same file also use 'bytestring' to refer to bytes objects
(cherry picked from commit 4b99803b86)

Co-authored-by: Florian Bruhin <me@the-compiler.org>
2022-01-19 13:58:13 -08:00
Miss Islington (bot) c4fe0aa670
Update documentation in datetime module strftime-and-strptime-behavior fix typo in '%W' format code description (GH-30232)
A small change to the documentation of datetime module , in the format codes section of stftime and strptime. Changed the description of format code '%W' from 'as a decimal number' to 'a zero padded   decimal number' so it's in line with the example having leading zeros.  Similar to the format code '%U' above.

Automerge-Triggered-By: GH:pganssle
(cherry picked from commit d45cd2d207)

Co-authored-by: Evan <binary-signal@users.noreply.github.com>
2022-01-19 10:02:07 -08:00
Miss Islington (bot) 24d0b331e8
[3.10] bpo-45680: Clarify documentation on ``GenericAlias`` objects (GH-29335) (GH-30688)
The documentation on ``GenericAlias`` objects implies at multiple points that
only container classes can define ``__class_getitem__``. This is misleading.
This PR proposes a rewrite of the documentation to clarify that non-container
classes can define ``__class_getitem__``, and to clarify what it means when a
non-container class is parameterized.

See also: initial discussion of issues with this piece of documentation in
GH-29308, and previous BPO issue [42280]().

Also improved references in glossary and typing docs. Fixed some links.

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 0eae9a2a2d)


Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Automerge-Triggered-By: GH:Fidget-Spinner
2022-01-19 07:24:14 -08:00
Erlend Egeberg Aasland 01e6cbefd3
[3.10] bpo-46402: Promote SQLite URI tricks in sqlite3 docs (GH-30660) (GH-30671)
* bpo-46402: Promote SQLite URI tricks in `sqlite3` docs (GH-30660)

Provide some examples of URI parameters in sqlite connect().

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
(cherry picked from commit bdf2ab1887)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

* Update suspicious rules
2022-01-18 16:57:33 -05:00
Miss Islington (bot) 4449a1694a
bpo-45554: Document multiprocessing.Process.exitcode values (GH-30142)
This addresses [bpo-45554]() by expanding the `exitcode` documentation to also describe what `exitcode` will be in cases of normal termination, `sys.exit()` called, and on uncaught exceptions.

Automerge-Triggered-By: GH:pitrou
(cherry picked from commit 3852269b91)

Co-authored-by: John Marshall <jmarshall@hey.com>
2022-01-18 13:51:30 -08:00
Miss Islington (bot) 9238a52cbc
bpo-20823: Clarify copyreg.pickle() documentation (GH-30230)
(cherry picked from commit 65940fa5c1)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-01-18 12:16:54 -08:00
Miss Islington (bot) 93dc1654dc
bpo-20281, bpo-29964: update datetime docs to refer %z and %Z to a pre-existing footnote (GH-30354)
(cherry picked from commit 305588c67c)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-01-14 15:59:20 -08:00
Miss Islington (bot) 26039d1e0a
bpo-23183: Document the timeit output (GH-30359)
Co-authored-by: Robert Collins <robertc@robertcollins.net>
(cherry picked from commit 73140de97c)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-01-14 09:47:51 -08:00
Miss Islington (bot) 3ce6945f5f
Define Py_BUILD_CORE_MODULE 2022-01-13 01:42:47 -08:00
Miss Islington (bot) da8c0759d2
Remove unused `Any` from `Concatenate` example in typing docs (GH-30516)
(cherry picked from commit 73decdf021)

Co-authored-by: Michael Oliver <michaeloliver__@outlook.com>
2022-01-11 06:21:40 -08:00
Miss Islington (bot) 987fba102e
bpo-46261: Update `sqlite3.Cursor.lastrowid` docs (GH-30407) 2022-01-08 22:05:43 +02:00
Miss Islington (bot) 8bef658668
bpo-46290: Fix parameter names in dataclasses docs (GH-30450)
(cherry picked from commit ef5376e69e)

Co-authored-by: Zsolt Dollenstein <zsol.zsol@gmail.com>
2022-01-08 07:09:40 -08:00
Miss Islington (bot) e35430bec5
[3.10] bpo-42378: fixed log truncation on logging shutdown (GH-27310) (GH-30468)
Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2022-01-07 22:15:25 +00:00
Miss Islington (bot) ed2656a7d3
bpo-28546: [doc] Clarify setting pdb breakpoints (GH-30360)
Co-authored-by: Ian Kelling <ian@iankelling.org>
(cherry picked from commit 6d07a9fb7c)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-01-07 12:03:36 -08:00
Miss Islington (bot) 6630952cf0
bpo-46216: remove spurious link to os.system() from os.time() documentation (GH-30326)
Automerge-Triggered-By: GH:iritkatriel
(cherry picked from commit 9b7aa6a9d6)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-01-07 10:50:09 -08:00
Miss Islington (bot) db60ed1170
[3.10] bpo-46251: Add 'Security Considerations' section to logging configura… (GH-30411) (GH-30447) 2022-01-06 23:18:41 +00:00
Miss Islington (bot) 289a32baf7
Fix missing "," in the documentation of Executor Objects (GH-30404)
(cherry picked from commit f404e26d74)

Co-authored-by: Philipp Claßen <philipp.classen@posteo.de>

Co-authored-by: Philipp Claßen <philipp.classen@posteo.de>
2022-01-04 11:17:16 -08:00