summaryrefslogtreecommitdiffstats
path: root/Doc/library
Commit message (Collapse)AuthorAgeFilesLines
* Remove the execution bit to some socket-related files. (GH-93368)Miss Islington (bot)2022-06-011-0/+0
| | | | | (cherry picked from commit 5247389369ac3da35c44f7c0d8f4facc0300883a) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* bpo-42272: fix misleading warning filter message/module docs (GH-23172)Miss Islington (bot)2022-05-301-6/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * bpo-42272: improve message/module warning filter docs "The Warnings Filter" section of the warnings module documentation describes the message and module filters as "a string containing a regular expression". While that is true when they are arguments to the filterwarnings function, it is not true when they appear in -W or $PYTHONWARNINGS where they are matched literally (after stripping any starting/ending whitespace). Update the documentation to note when they are matched literally. Also clarify that module matches the "fully-qualified module name", rather than "module name" which is ambiguous. skip news (since this is a doc fix) Signed-off-by: Kevin Locke <kevin@kevinlocke.name> * bpo-42272: remove bad submodule warning filter doc The `error:::mymodule[.*]` example in the "Describing Warning Filters" section of the warnings module documentation does not behave as the comment describes. Since the module portion of the filter string is interpreted literally, it would match a module with a fully-qualified name that is literally `mymodule[.*]`. Unfortunately, there is not a way to match '"module" and any subpackages of "mymodule"' as documented, since the module part of a filter string is matched literally. Instead, update the filter and comment to match only "mymodule". skip news (since this is a doc fix) Signed-off-by: Kevin Locke <kevin@kevinlocke.name> * bpo-42272: add warning filter doc changes to NEWS Signed-off-by: Kevin Locke <kevin@kevinlocke.name> (cherry picked from commit 8136606769661c103c46d142e52ecbbbb88803f6) Co-authored-by: Kevin Locke <kevin@kevinlocke.name>
* gh-77024: test.support: Improve documentation (GH-92513)Miss Islington (bot)2022-05-271-42/+68
| | | | | | | | | | | | | This is a rework of GH-5774 on current main. I was a bit more conservative in making changes than the original PR. See @csabella's comments on issue GH-77024 and the discussion on GH-5774 for explanations of several of the changes. Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 8995177030c8b41885ad92b260279b7e622ecaea) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.10] gh-92859: Doc: add info about logging.debug() calling basicConfig() ↵Miss Islington (bot)2022-05-231-0/+8
| | | | (GH-93063) (GH-93150)
* gh-92994: Clarify importlib "check" example (GH-92995)Miss Islington (bot)2022-05-231-0/+3
| | | | | | Fixes GH-92994 (cherry picked from commit e39cd765610c9099da3b5595186ad16223b670b0) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* gh-73137: Added sub-subsection headers for flags in re (GH-93000)Miss Islington (bot)2022-05-231-30/+42
| | | | | | Fixes GH-73137 (cherry picked from commit b7a6610bc88dfecdd943e8d2817f7cd6b85fb740) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* gh-91362: reword pickle docs to account for nested classes (GH-92429)Miss Islington (bot)2022-05-211-6/+6
| | | | | | Fixes GH-91362 (cherry picked from commit f9d6c59917435980fbe1b58c57257c45bfed2244) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* [3.10] gh-72073: Add Windows case in pathlib.rename (GH-93002) (GH-93029)Miss Islington (bot)2022-05-201-2/+3
| | | | | | | | | | | GH-72073 https://docs.python.org/3.12/library/pathlib.htmlGH-pathlib.Path.rename (cherry picked from commit f51ed04c663417f88e10eeb21dad23250358bafa) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Automerge-Triggered-By: GH:brettcannon
* Doc: add missing manpage and title references in tkinter docs (GH-29008)Miss Islington (bot)2022-05-201-2/+3
| | | | | | | - add bind(3tk) manpage markup - add Tcl/Tk book reference markup (cherry picked from commit 0e12781ad9dec6e46ccb85969c0eb7be1ecad81d) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* bpo-46879: Fix incorrect sphinx object names in doc (GH-31615) (GH-92975)Miss Islington (bot)2022-05-193-0/+7
| | | | | | (cherry picked from commit 2cdd57f119e3b85f1bfd28c7ff040e0d9bcaf115) Co-authored-by: Łukasz Langa <lukasz@langa.pl> Co-authored-by: Martin Fischer <martin@push-f.com>
* gh-92417: `subprocess` docs: remove note on compatibility with Python <3.5 ↵Miss Islington (bot)2022-05-191-3/+0
| | | | | | | (GH-92538) (GH-92973) (cherry picked from commit 84b86000e2bc32b0fbb6dfb6445a7ffc882067d2) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-92417: `fractions`, `decimal`: Improve docs for alternative constructor ↵Miss Islington (bot)2022-05-192-8/+9
| | | | | | | | methods (GH-92421) (GH-92971) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> (cherry picked from commit 090df844ea16af3a5df79aba2b9c89ac6a31ba06) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-92417: `socket` docs: remove references to Python <3.3 (GH-92544) (GH-92969)Miss Islington (bot)2022-05-191-2/+2
| | | | | (cherry picked from commit 639b62c9c479e38a6f91a80b261097574a1e7ac7) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-92417: Update docs and examples of doctest.IGNORE_EXCEPTION_DETAIL for ↵Miss Islington (bot)2022-05-191-27/+21
| | | | | | Py>=3 (GH-92502) (GH-92963) (cherry picked from commit 97b9c1096feff77a564787ef520cc7d4e1d1c45f)
* Doc: amend ssl.PROTOCOL_SSLv2 and ssl.PROTOCOL_SSLv3 wording (GH-92634)Miss Islington (bot)2022-05-191-3/+3
| | | | | (cherry picked from commit 41638967a0e0bf1114c9bba9454d081605b49009) Co-authored-by: Jan Brasna <1784648+janbrasna@users.noreply.github.com>
* gh-92812: Align ArgumentParser.add_subparsers() docs with argument spec ↵Miss Islington (bot)2022-05-181-1/+1
| | | | | | | (GH-92814) (cherry picked from commit f2d994da104eed38f9e110e7d8f37fa6d845b207) Co-authored-by: 180909 <734461790@qq.com>
* bpo-40838: document `getdoc`, `getmodule`, `getsourcefile` in `inspect` ↵Miss Islington (bot)2022-05-181-2/+5
| | | | | | | | | returns `None` (GH-30575) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit b86d783a4eff96306f315acf9a6f1aca85d47fc3) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* gh-92780: Improve sqlite3.Connection.create_collation docs (GH-92790)Miss Islington (bot)2022-05-181-11/+8
| | | | | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 7ee19e27150a72eec9e6a076792e3c3ae8bcffbd) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
* Fix typo in argparse docs. (GH-92691) (#92729)thueringa2022-05-131-1/+1
|
* gh-92611: Link to PEP 594 sections & add key detail in doc deprecation ↵Miss Islington (bot)2022-05-1321-22/+46
| | | | | | | notices (GH-92612) (cherry picked from commit 9f68dab3d327335b938046c50b4f09944e993cc8) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-92436: __future__ docs: add note on expectations for "from __future__ ↵Miss Islington (bot)2022-05-121-1/+9
| | | | | | | import annotations" (GH-92568) (cherry picked from commit 6582c96454ddb731eb412c2a473300172225fdb9) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* Fix minor documentation error in bisect docs (GH-92697)Miss Islington (bot)2022-05-111-1/+1
| | | | | (cherry picked from commit b3f99b69d03cf0ea72a567a81e8bc4bc074ab303) Co-authored-by: Steve Dower <steve.dower@python.org>
* [3.10] Fix typo in unittest.rst: addCleanupModule -> addModuleCleanup ↵Miss Islington (bot)2022-05-111-1/+1
| | | | | | | | | | (GH-92631) (GH-92660) (cherry picked from commit 38486ca212c0827d54e7b0d0b1e2c1ccc2bdad33) Co-authored-by: Mikhail Terekhov <termim@gmail.com> Automerge-Triggered-By: GH:serhiy-storchaka
* gh-91966 Document where key functions are applied in the bisect module ↵Miss Islington (bot)2022-05-111-15/+52
| | | | (GH-92602) (#92666)
* [3.10] gh-76773: Update docs mentioning no-longer-supported Windows versions ↵Miss Islington (bot)2022-05-104-9/+4
| | | | | | | | | | & features (GH-92529) (GH-92609) (cherry picked from commit f1bbcba74f77eff2a4c0881f3d529f3bf0664d40) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> Automerge-Triggered-By: GH:serhiy-storchaka
* bpo-13553: Document tkinter.Tk args (GH-4786)Miss Islington (bot)2022-05-101-10/+66
| | | | | (cherry picked from commit c56e2bb9949c95ec8911cd5554b07044a564796f) Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
* bpo-38056: overhaul Error Handlers section in codecs documentation (GH-15732)Miss Islington (bot)2022-05-091-73/+116
| | | | | | | | | | | | | * Some handlers were wrongly described as text-encoding only, but actually they can also be used in text-decoding. * Add more description to each handler. * Add two REPL examples. * Add indexes for Error Handler's name. Co-authored-by: Kyle Stanley <aeros167@gmail.com> Co-authored-by: Victor Stinner <vstinner@python.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 5bc2390229bbcb4f13359e867fd8a140a1d5496b) Co-authored-by: Ma Lin <animalize@users.noreply.github.com>
* bpo-39229: fix formatting in library/functions.rst (GH-17857)Miss Islington (bot)2022-05-081-2/+2
| | | | | | Missing reference of auditing event presents error when building translated documentation (cherry picked from commit f298ba1f2712ad10530a30bb225548a6889820b5) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* pdb docs: workaround for double semicolon in strings (GH-17011)Miss Islington (bot)2022-05-081-1/+2
| | | | | | | | see https://github.com/gotcha/ipdb/issues/172 Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 2888b1107fd0b43cc800987a00155bdbeacdb23a) Co-authored-by: Godefroid Chapelle <gotcha@bubblenet.be>
* gh-80856: doc: reveal doctest directives (GH-92318)Miss Islington (bot)2022-05-081-17/+37
| | | | | | | | | | | * Doc: Reveal doctest directives. * Fix whitespace. Co-authored-by: Julien Palard <julien@palard.fr> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> (cherry picked from commit 7b024e3a3f77027f747da7580ed0a3ed2dec276a) Co-authored-by: Davide Rizzo <sorcio@gmail.com>
* gh-92417: `logging` docs: Remove warning that only applies to Python <3.2 ↵Miss Islington (bot)2022-05-081-10/+0
| | | | | | | (GH-92425) (cherry picked from commit 318c4e91ef166bcd5d513bb42b9156d54d423d4a) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.10] gh-92417: `asyncio` docs: `asyncio.run()` is available on all ↵Miss Islington (bot)2022-05-081-1/+0
| | | | | | | | | | supported Python versions (GH-92419) (GH-92463) (cherry picked from commit f4e317b304c7f86e48885b4b74c7a8826648922c) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Automerge-Triggered-By: GH:serhiy-storchaka
* [3.10] gh-92417: `json` docs: `dict` is ordered on all supported Python ↵Miss Islington (bot)2022-05-081-7/+0
| | | | | | | | | | versions (GH-92422) (GH-92465) (cherry picked from commit bc098cfdb756f207d8fa84793e8ad91a2f263efb) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Automerge-Triggered-By: GH:serhiy-storchaka
* [3.10] gh-92417: `doctest` docs: remove references to Python <3.6 (GH-92420) ↵Miss Islington (bot)2022-05-081-9/+0
| | | | | | | | | | (GH-92468) (cherry picked from commit 5639ea1ef9ba8452f81b61ad73152bd1bf1fd3a6) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Automerge-Triggered-By: GH:serhiy-storchaka
* [3.10] gh-77630: Change Charset to charset (GH-92439) (GH-92476)Miss Islington (bot)2022-05-081-7/+7
| | | | | | | | (cherry picked from commit 8f293180791f2836570bdfc29aadba04a538d435) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com> Automerge-Triggered-By: GH:serhiy-storchaka
* [3.10] gh-92417: `stdtypes` docs: delete discussion of Python 2 differences ↵Miss Islington (bot)2022-05-081-10/+0
| | | | | | | | | | | | | (GH-92423) (GH-92473) Given that 2.7 has now been end-of-life for two and a half years, I don't think we need such a detailed explanation here anymore of the differences between Python 2 and Python 3. (cherry picked from commit 8efda1e7c6343b1671d93837bf2c146e4cf77bbf) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Automerge-Triggered-By: GH:serhiy-storchaka
* gh-92417: `typing` docs: `from __future__ import annotations` can be used in ↵Miss Islington (bot)2022-05-081-1/+1
| | | | | | | all supported Python versions (GH-92418) (cherry picked from commit e5b4bd4d60aaf0292c5b9d628512145b8987b3c6) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-92223: Remove pre-Python 3.7 alternative in asyncio docs (GH-92224)Miss Islington (bot)2022-05-051-16/+1
| | | | | (cherry picked from commit d1b2e989be2bc5128d6602e4f370d0ee6f5ac476) Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
* [3.10] Improve the typing docs (GH-92264) (#92270)Jelle Zijlstra2022-05-031-21/+20
| | | | | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>. (cherry picked from commit 27e366571590e9e98f61dccf69dbeaa88ee66737) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* bpo-46586: Fix more erroneous doc links to builtins (GH-31429)Miss Islington (bot)2022-05-023-3/+3
| | | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Éric <merwok@netwok.org> (cherry picked from commit cc6ae4f4835f9e76a34f24cd1f666c1cc0fecfa3) Co-authored-by: Meer Suri <46469858+meersuri@users.noreply.github.com>
* bpo-6686: Replace String with Bytes in xml.sax.handler documentation (GH-30612)Miss Islington (bot)2022-05-021-1/+1
| | | | | (cherry picked from commit 32e4f450af3fbcc5c7e186f83ff74e2efe164136) Co-authored-by: Yassir Karroum <ukarroum17@gmail.com>
* importlib docs: Update importlib.abc hierarchy (GH-31113)Miss Islington (bot)2022-05-021-4/+3
| | | | | | Fixed some inconsistencies in the text about relationships (cherry picked from commit 5f45a9d3c3de97a4eafedb60ecea224a78bae52c) Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
* [3.10] bpo-43504: Remove effbot urls (GH-26308) (#92161)Thaddeus14992022-05-022-13/+0
| | | | | | * [3.10] Remove effbot urls (GH-26308). (cherry picked from commit e9f66aedf44ccc3be27975cfb070a44ce6a6bd13) Co-authored-by: E-Paine <63801254+E-Paine@users.noreply.github.com>
* gh-91783: Document security considerations for shutil.unpack_archive (GH-91844)Miss Islington (bot)2022-05-021-1/+7
| | | | | (cherry picked from commit 4b297a9ffd4a1d420c1a8016f4ed2c7f1d298469) Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
* gh-92082: contextlib docs: Change aclosing from a class to a function for ↵Miss Islington (bot)2022-05-021-1/+1
| | | | | | | | consistency (GH-92155) Signed-off-by: prwatson <prwatson@redhat.com> (cherry picked from commit 958f21c5cdb3bbbd16fec87164785cff3dacce96) Co-authored-by: Thaddeus1499 <104600742+Thaddeus1499@users.noreply.github.com>
* gh-88546: glob.glob docs: Make new paragraph for emphasis and reordered ↵Miss Islington (bot)2022-05-021-2/+5
| | | | | | | sentence (GH-91614) (cherry picked from commit b9ab6cea0819bd498063f0934cb5bb0bb5a6a2d4) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* asyncio.subprocess: Fix a typo in doc (GH-92030)Miss Islington (bot)2022-05-021-1/+1
| | | | | | Remove a confusion for read method in asyncio-subprocess doc for stderr StreamReader instance (cherry picked from commit bb857a96ef368ba9de1da2db12b1a1f1870606ac) Co-authored-by: Harsh <65716674+Harsh-br0@users.noreply.github.com>
* gh-85133: os docs: Add that getenv uses os.environ (GH-91874)Miss Islington (bot)2022-05-021-13/+21
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit b25352a5c039d95e019dd8ca111f6f77c43ca1f7) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* gh-84714: Add behavior if dst file exists (GH-91867)Miss Islington (bot)2022-05-021-1/+2
| | | | | (cherry picked from commit 9166ace805d915c8a918cd89fff0e58b65e3327c) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* typing docs: Add example for async functions (GH-20386)Miss Islington (bot)2022-05-011-0/+4
| | | | | | Fixes python/typingGH-424 (cherry picked from commit 9588f880a286a8cc5597188f6ab44108c8f18761) Co-authored-by: Sam Bull <aa6bs0@sambull.org>
generated by cgit v0.12 at 2026-01-08 06:40:26 (GMT)