summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: C API: Demote sections to subsections for consistency (#126535)Richard Hansen2024-11-071-7/+7
| | | | The entire file should be a single section; the headings below the first heading should be subsections.
* gh-48020: [docs] Remove the logging howto suggested future FileHandler ↵Gregory P. Smith2024-11-071-5/+2
| | | | | | | | | multiprocessing support (GH-126531) Docs: Remove the logging howto potential promise of multiprocessing support in the future. Stick to the facts and suggestions, don't provide hope where we're not going to implement complexity that we'd rather the user implement themselves when needed.
* gh-122838: Document missing opcodes (#123073)Kamil Turek2024-11-061-0/+21
|
* gh-120754: Add to `io` optimization to what's new (#126466)Cody Maloney2024-11-061-0/+9
|
* GH-124985: Document that `pathlib.Path.copy()` uses copy-on-write. (#125861)Barney Gale2024-11-051-0/+5
|
* Doc: C API: Delete claim that `PyObject_Init` is GC-aware (#126418)Richard Hansen2024-11-051-4/+2
|
* gh-119793: Prefer `map(..., strict=True)` over starmap/zip in examples (#126407)Lukas Geiger2024-11-051-1/+1
|
* gh-120057: Add os.reload_environ() function (#126268)Victor Stinner2024-11-052-12/+28
| | | | | | | Replace the os.environ.refresh() method with a new os.reload_environ() function. Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-125436: Doc: Add missing ``allow_unnamed_section`` parameter to ↵lit2024-11-051-3/+28
| | | | | | | ``ConfigParser`` documentation (#125437) Add missing ``allow_unnamed_section`` parameter to ``ConfigParser`` doc, as well as to it's parent ``RawConfigParser``. Split too long line on ``ConfigParser`` signature. Add some sections about when some of ``RawConfigParser`` parameters were added.
* Doc: Fix typo in documentation for ``MAKE_FUNCTION`` opcode (#126396)Mikhail Efimov2024-11-041-1/+1
|
* gh-101865: Docs: Keep co_lnotab deprecation for at least 3.14 (#126392)Hugo van Kemenade2024-11-044-10/+12
|
* gh-119793: Add optional length-checking to `map()` (GH-120471)Nice Zombies2024-11-042-3/+12
| | | | | | Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* gh-126353: remove implicit creation of loop from `asyncio.get_event_loop` ↵Kumar Aditya2024-11-043-8/+10
| | | | | (#126354) Remove implicit creation of loop from `asyncio.get_event_loop`. This is a step forward of deprecating the policy system of asyncio.
* Docs: turn getopt examples into doctests (#126377)Erlend E. Aasland2024-11-041-2/+10
|
* gh-126165: Improve docs of function `math.isclose` (#126215)Zhikang Yan2024-11-042-16/+20
| | | | | Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* Docs: Delist sqlite3 deprecation from "Pending removal in 3.14" (#126370)Hugo van Kemenade2024-11-031-3/+0
|
* gh-99880: document rounding mode for new-style formatting (GH-121481)Sergey B Kirpichev2024-11-021-0/+5
| | | | | | | | | | | | | | | | | | | | * gh-99880: document rounding mode for new-style formatting The CPython uses _Py_dg_dtoa(), which does rounding to nearest with half to even tie-breaking rule. If that functions is unavailable, PyOS_double_to_string() fallbacks to system snprintf(). Since CPython 3.12, build requirements include C11 compiler *and* support for IEEE 754 floating point numbers (Annex F). This means that FE_TONEAREST macro is available and, per default, printf-like functions should use same rounding mode as _Py_dg_dtoa(). * Update Doc/library/string.rst Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> --------- Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* gh-125761: Clarify repeated warning suppression criteria in warnings module ↵고병찬2024-11-021-0/+13
| | | | (gh-126326)
* gh-125875: Fix docs typo FORMAT_SPEC to FORMAT_WITH_SPEC (gh-126319)rimchoi2024-11-021-1/+1
| | | Fix docs typo FORMAT_SPEC to FORMAT_WITH_SPEC
* gh-120026: soft deprecate Py_HUGE_VAL macro (#120027)Sergey B Kirpichev2024-11-012-1/+5
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Doc: Add a single table as summary to math documentation (GH-125810)Joseph Martinot-Lagarde2024-11-011-3/+89
| | | | | | | | | | | | | | | | | | | | | | | | | * Summary for math module with separate tables * Forgot remainder description * Single table * data instead of func * Add arguments in the table * Fix inconsistencies in pow documentation * Remove full stops from the table Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> * Fix math.pow link * Fix spacing --------- Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* docs: add a more precise example in enum doc (GH-121015)Filip "Ret2Me" Poplewski2024-11-011-1/+1
| | | | | | | | | | | | | * docs: add a more precise example Previous example used manual integer value assignment in class based declaration but in functional syntax has been used auto value assignment what could be confusing for the new users. Additionally documentation doesn't show how to declare new enum via functional syntax with usage of the manual value assignment. * docs: remove whitespace characters * refactor: change example --------- Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
* gh-97850: remove ``find_loader`` and ``get_loader`` from ``pkgutil`` (#119656)Bénédikt Tran2024-11-014-42/+9
| | | | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Brett Cannon <brett@python.org>
* gh-126259: Fix "unclosed database" warning in sqlite3 doctest (#126260)sobolevn2024-11-011-0/+1
|
* GH-125413: Add `pathlib.Path.scandir()` method (#126060)Barney Gale2024-11-012-0/+35
| | | | | Add `pathlib.Path.scandir()` as a trivial wrapper of `os.scandir()`. This will be used to implement several `PathBase` methods more efficiently, including methods that provide `Path.copy()`.
* gh-126256: Update time.rst to use the same clock as instead of the same ↵Alperen Keleş2024-10-311-2/+2
| | | | | | | clock than (#126257) Update time.rst to use `the same clock as` instead of `the same clock than` The time documentation uses the same clock than time.monotonic instead of the same clock as time.monotonic, which is grammatically false. This PR fixes changes two instances of `the same clock than` to `the same clock as`.
* gh-125818: Fix incorrect signature of argument `skip_file_prefixes` in ↵RUANG (James Roy)2024-10-311-1/+1
| | | | | warnings docs (GH-125823) Change documentation
* gh-125674: Doc: Fix type of `newfunc` first parameter (GH-125675)Richard Hansen2024-10-301-2/+2
| | | | | | | | | * gh-125674: Doc: Fix type of `newfunc` first parameter * fixup! gh-125674: Doc: Fix type of `newfunc` first parameter --------- Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-114990: Add missing mixin methods in collections.abc's document (GH-114991)AN Long2024-10-301-2/+3
| | | Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
* gh-126055: Add omitted command (in docs [os.walk]) for code to fulfill ↵Victor Wheeler2024-10-301-0/+1
| | | | | | | | | `shutil.rmtree` algorithm (GH-126067) * gh-126055: Add omitted command (in docs [os.walk]) for code to fulfill `shutil.rmtree` algorithm. Resolves #126055 * gh-126055: Fix omitted code highlighting
* gh-60712: Include the "object" type in the lists of documented types (GH-103036)Furkan Onder2024-10-302-18/+41
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add test for the predefined object's attributes * Include the "object" type in the lists of documented types * remove 'or' from augment tuple * 📜🤖 Added by blurb_it. * Add cross-reference to news Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> * Fix format for the function parameter Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> * Add space Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> * add reference for the 'object' Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> * add reference for NotImplemented Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> * Change ref:`string <textseq>` as class:`str` Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> * remove hyphen from `newly-created` * Update Doc/reference/datamodel.rst 'dictionaries' to 'dict' Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> * Update predefined attribute types in testPredefinedAttrs * Change `universal type` as `top type` * Don't mention about the top type * Update the description of richcmpfuncs * Update Doc/library/stdtypes.rst Co-authored-by: Éric <merwok@netwok.org> * Revert: Hierarchy Section in Data Model Documentation * Revert to original explanations of __new__ and __init__ methods in datamodel.rst for improved clarity. * Update Doc/reference/datamodel.rst Co-authored-by: Éric <merwok@netwok.org> * Remove blank line Co-authored-by: Éric <merwok@netwok.org> * Use ref:`str <textseq>` instead of :class:`str Co-authored-by: Éric <merwok@netwok.org> * Revert changes the description of Other Built-in Types in stdtypes.rst * Update Doc/reference/datamodel.rst Co-authored-by: Éric <merwok@netwok.org> --------- Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
* Fix incorrect indentation in importlib.metadata.rst (GH-126189)Rafael Fontenelle2024-10-301-3/+3
|
* gh-85583: Add f-string index in tutorial/inputoutput.rst (GH-21681)amaajemyfren2024-10-301-0/+7
| | | | | | | | | | | | * bpo-41411 fstring index in tutorial/inputoutput To assist in searching for fstrings I have added an index * Add newline --------- Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
* gh-125669: Do not run `-ugui` tests by default on `make test` (#125730)sobolevn2024-10-301-1/+9
| | | Adds `make ci` target for use in CI and keeping `make test` for the local development.
* gh-126072: do not add `None` to `co_consts` if there is no docstring (GH-126101)Xuanteng Huang2024-10-302-3/+11
|
* gh-126071: Improve formatting of the argparse documentation (GH-126073)Serhiy Storchaka2024-10-301-65/+72
| | | | | | | | | * Use appropriate roles for ArgumentParser, Action, etc. * Remove superfluous repeated links. * Explicitly document signatures and add index entries for some methods and classes. * Make it more clear that some parameters are keyword-only. * Fix some minor errors.
* gh-118633: Add warning regarding the unsafe usage of eval and exec (GH-118437)Daniel Ruf2024-10-301-0/+10
| | | | | | | | | | | | | | | | | | | | | | * Add warning regarding the unsafe usage of eval * Add warning regarding the unsafe usage of exec * Move warning under parameters table * Use suggested shorter text Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> * Use suggested shorter text Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> * Improve wording as suggested --------- Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-58032: Docs: Sort argparse alphabetically (GH-125871)Hugo van Kemenade2024-10-302-21/+20
| | | Sort argparse alphabetically
* gh-124855: Don't allow the JIT and perf support to be active at the same ↵Pablo Galindo Salgado2024-10-301-0/+2
| | | | time (#124856)
* docs: restore an anchor to for/else (#126154)Ned Batchelder2024-10-301-0/+1
|
* Doc: Note that pydoc uses and prefers ``MANPAGER`` (#125362)Matthieu Ancellin2024-10-292-2/+4
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* bpo-41793: Fix an inaccuracy about reflected methods in datamodel docs ↵Wim Jeantine-Glenn2024-10-291-11/+14
| | | | | | | (GH-22257) * Qualifying that the right operand's type must be a *strict* subclass for the reflected method to take precedence avoids an edge case / counter-example when the types are actually equal. Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
* gh-116938: Fix `dict.update` docstring and remove erraneous full stop from ↵Prometheus33752024-10-291-1/+1
| | | | | `dict` documentation (#125421) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Add lightweight comments to conf.py and update docs readme (GH-126100)Carol Willing2024-10-292-14/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Update contributing contact info in readme * Add lightweight comments to improve docs workflow understanding * Apply code review suggestions from @hugovk Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> * Add code review suggestion from @AA-Turner Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> * Update Doc/conf.py Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> * Update Doc/conf.py Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> * Update Doc/conf.py Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --------- Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-122767: document "new style" formatting for complexes (GH-122848)Sergey B Kirpichev2024-10-291-5/+15
| | | Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* GH-125837: Split `LOAD_CONST` into three. (GH-125972)Mark Shannon2024-10-292-8/+17
| | | | | | | | * Add LOAD_CONST_IMMORTAL opcode * Add LOAD_SMALL_INT opcode * Remove RETURN_CONST opcode
* gh-89762: Document strftime %G, %V, and %u format specifiers (#124572)RUANG (James Roy)2024-10-281-0/+13
|
* gh-126012: Add `__class_getitem__` to `memoryview` (#126013)Brian Schubert2024-10-272-0/+7
| | | | Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
* gh-125633: Add function `ispackage` to stdlib `inspect` (#125634)Zhikang Yan2024-10-272-0/+11
| | | | | --------- Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
* Fix a typo in ``Doc/tutorial/errors.rst`` exception output (#126001)Bogdana Vereha2024-10-261-1/+1
|
generated by cgit v0.12 at 2025-03-21 18:05:58 (GMT)