summaryrefslogtreecommitdiffstats
path: root/Doc/glossary.rst
Commit message (Collapse)AuthorAgeFilesLines
* [3.12] gh-101100: Fix most Sphinx nitpicks in the glossary and ↵Miss Islington (bot)2023-12-061-21/+26
| | | | | | | | `stdtypes.rst` (GH-112757) (#112789) gh-101100: Fix most Sphinx nitpicks in the glossary and `stdtypes.rst` (GH-112757) (cherry picked from commit e3f670e13792305cfb977d5cffd8e6aa03e8fe7f) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] Glossary: Add "static type checker" (GH-111837) (#111854)Miss Islington (bot)2023-11-081-2/+7
| | | | | | | Glossary: Add "static type checker" (GH-111837) (cherry picked from commit 8ab7ad63086b1793c24b1c5aaa19b60fc0e6540e) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] GH-101100: Fix reference warnings for ``__enter__`` and ``__exit__`` ↵Miss Islington (bot)2023-10-191-1/+1
| | | | | | (GH-110112) (#111075) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] GH-101100: Fix reference warnings for ``__getitem__`` (GH-110118) ↵Miss Islington (bot)2023-10-191-4/+4
| | | | | | (#111073) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) ↵Miss Islington (bot)2023-08-081-5/+10
| | | | | | | | | | | | | | | | | | (#107752) * gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts. In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has. This change updates the documentation to reflect that perspective. It also updates the docs relative to immortal objects in a handful of places. (cherry picked from commit 5dc825d504ad08d64c9d1ce578f9deebbe012604) Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com> * Fix a typo. --------- Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
* [3.12] gh-101100: Fix reference to asynchronous methods (GH-106172) (#106191)Miss Islington (bot)2023-06-281-9/+9
| | | | | | gh-101100: Fix reference to asynchronous methods (GH-106172) (cherry picked from commit bbf722dcd39c66418e45991dcf1cdf140c2ce20e) Co-authored-by: F3eQnxN3RriK <drsuaimqjgar@gmail.com>
* gh-87864: Use correct function definition syntax in the docs (#103312)Nikita Sobolev2023-04-111-1/+1
|
* glossary.rst: Fix typo in package definition (GH-98865)ab2022-10-291-1/+1
| | | | | | This is a tiny typo fix of package definition in glossary. According to https://devguide.python.org/documentation/help-documenting/ simple typos don’t require issues of their own, but, instead, a pull request can by submitted directly. Automerge-Triggered-By: GH:AlexWaygood
* gh-95276: Add callable entry to the glossary (#95738)MonadChains2022-10-121-0/+10
|
* gh-96397: Document that attributes need not be identifiers (#96454)Jeff Allen2022-09-291-2/+9
| | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-84910: Tweak IDLE Glossary entry (#95866)Terry Jan Reedy2022-08-111-3/+3
| | | | Link "IDLE" to its doc and add 'and Learning' to its expansion, as in the doc.
* Docs: remove redundant "adverb-adjective" hyphens from compound modifiers ↵Ned Batchelder2022-07-051-1/+1
| | | | | (GH-94551) Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
* bpo-38056: overhaul Error Handlers section in codecs documentation (#15732)Ma Lin2022-05-091-1/+10
| | | | | | | | | | * 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>
* bpo-47000: Add `locale.getencoding()` (GH-32068)Inada Naoki2022-04-091-6/+6
|
* Update glossary.rst (GH-32093)Géry Ogam2022-03-291-8/+7
|
* bpo-43698: do not use `...` as argument name in docs (GH-30502)Nikita Sobolev2022-01-261-2/+2
|
* bpo-45250: fix docs regarding `__iter__` and iterators being inconsistently ↵Brett Cannon2021-11-201-0/+5
| | | | | required by CPython (GH-29170) It is now considered a historical accident that e.g. `for` loops and the `iter()` built-in function do not require the iterators they work with to define `__iter__`, only `__next__`.
* [doc] bpo-45680: Improve glossary entry for generic types (GH-29388)Alex Waygood2021-11-061-4/+5
| | | Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* bpo-44693: Update __future__ entry in Doc/glossary.rst (GH-27349)Steven Hsu2021-07-261-6/+7
| | | | | | Replace sentence with confusing "pseudo-module" with two sentences separating future statements and the __future__ module. Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-44651: delete entry of "coercion" in Doc/glossary.rst (GH-27226)Steven Hsu2021-07-221-10/+0
| | | | bpo 44651: delete entry of "coercion".
* Remove duplicate words in docs. (GH-26167)Mariusz Felisiak2021-05-211-1/+1
|
* bpo-43987: Add "Annotations Best Practices" HOWTO doc. (#25746)larryhastings2021-05-021-0/+6
| | | Add "Annotations Best Practices" HOWTO doc.
* bpo-42294: Grammar fixes in doc glossary strong/weak refs (GH-23227)kj2020-11-101-5/+5
|
* bpo-42294: Add borrowed/strong reference to doc glossary (GH-23206)Victor Stinner2020-11-091-0/+24
| | | | | | Add "borrowed reference" and "strong reference" to the documentation glossary. Enhance also Py_INCREF() and Py_NewRef() documentation.
* bpo-42236: Enhance init and encoding documentation (GH-23109)Victor Stinner2020-11-021-0/+31
| | | | | | | | | | | | | | | | | | | | | Enhance the documentation of the Python startup, filesystem encoding and error handling, locale encoding. Add a new "Python UTF-8 Mode" section. * Add "locale encoding" and "filesystem encoding and error handler" to the glossary * Remove documentation from Include/cpython/initconfig.h: move it to Doc/c-api/init_config.rst. * Doc/c-api/init_config.rst: * Document command line options and environment variables * Document default values. * Add a new "Python UTF-8 Mode" section in Doc/library/os.rst. * Add warnings to Py_DecodeLocale() and Py_EncodeLocale() docs. * Document how Python selects the filesystem encoding and error handler at a single place: PyConfig.filesystem_encoding and PyConfig.filesystem_errors. * PyConfig: move orig_argv member at the right place.
* bpo-41805: Documentation for PEP 585 (GH-22615)kj2020-10-271-0/+7
|
* [doc] Fix link to abc.ABCMeta.register in Glossary (GH-22932)Andre Delfino2020-10-241-1/+1
|
* Create a primer section for the descriptor howto guide (GH-22906)Raymond Hettinger2020-10-231-1/+2
|
* bpo-29981: Add examples and update index for set, dict, and generator ↵Florian Dahlitz2020-10-201-0/+12
| | | | | | comprehensions'(GH-20272) Co-authored-by: Rémi Lapeyre <remi.lapeyre@henki.fr>
* [doc] Leverage the fact that the actual types can now be indexed for typing ↵Andre Delfino2020-09-271-7/+3
| | | | | | | | | | | (GH-22340) This shows users that they can use the actual types. Using deprecated types is confusing. This also prefers colections.abc.Sized instead of the alias typing.Sized. I guess the aliases were created to make it convenient to import all collections related types from the same place. This should be backported to 3.9. Automerge-Triggered-By: @gvanrossum
* bpo-40204: Fix reference to terms in the doc (GH-21865)Victor Stinner2020-08-141-1/+1
| | | | | | | | Sphinx 3 requires to refer to terms with the exact case. For example, fix the Sphinx 3 warning: Doc/library/pkgutil.rst:71: WARNING: term Loader not found in case sensitive match.made a reference to loader instead.
* Improve asyncio.loop.call_soon() documentation (GH-20883)Roger Iyengar2020-06-231-0/+4
| | | | | | * Add a glossary entry for the term "callback" * Link to it in loop.call_soon() and in the "Concurrency and Multithreading" section Co-authored-by: Kyle Stanley <aeros167@gmail.com>
* bpo-39233: Update positional-only section in the glossary (GH-17874)Pablo Galindo2020-01-081-3/+5
| | | https://bugs.python.org/issue39233
* Fix and improve `asyncio.run()` docs (GH-16403)Kyle Stanley2019-10-011-1/+1
|
* bpo-38096: Complete the "structseq" and "named tuple" cleanup (GH-16010)Raymond Hettinger2019-09-121-1/+1
|
* bpo-38096: Clean up the "struct sequence" / "named tuple" docs (GH-15895)Raymond Hettinger2019-09-111-19/+22
| | | | | | | | * bpo-38096: Clean up the "struct sequence" / "named tuple" docs * Fix remaining occurrences of "struct sequence" * Repair a user visible docstring
* Doc: Space breaking whole definition. (GH-13615)Julien Palard2019-05-281-1/+1
|
* bpo-37051: Refine note on what objects are hashable (GH-13587)Raymond Hettinger2019-05-271-2/+4
|
* bpo-32995 - Added context variable in glossary (GH-9741)Vinodhini Balusamy2019-05-141-0/+9
|
* bpo-36822: Fix minor grammatical error in glossary.rst (GH-13145)Sanyam Khurana2019-05-111-4/+4
|
* bpo-33832: Add "magic method" glossary entry (GH-7630)Andre Delfino2019-03-271-0/+7
|
* bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)Serhiy Storchaka2018-12-191-3/+3
|
* Fix typo in asynchronous generator iterator documentation (GH-10542)Sebastián Ramírez2018-11-151-2/+2
| | | | Remove an unnecessary "that": ... will execute that the body ... -> ... will execute the body ...
* Improve grammar in Glossary. (GH-10474)Windson yang2018-11-121-2/+2
| | | a asynchronous generator -> an asynchronous generator
* bpo-9842: Add cross-reference to the ellipsis object (GH-4063)Pablo Galindo2018-11-041-4/+8
| | | | | | This PR adds a cross-reference to the ellipsis object and the representation of recursive item in containers as indicated in [issue 9842](https://bugs.python.org/issue9842) by @bitdancer. https://bugs.python.org/issue9842
* bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)Stéphane Wirtel2018-10-261-1/+1
|
* Fix struct sequence glossary entry grammar (GH-9030)Zachary Ware2018-09-021-1/+1
| | | | | ... by removing a superfluous "either". Reported by Никита Люшненко on docs@.
* Improve grammar of asynchronous iterator glossary entry (GH-8657)Andrés Delfino2018-08-091-3/+3
|
* bpo-33571: Improve the glossary description for '...' prompt (GH-6971)Andrés Delfino2018-06-161-2/+3
| | | | Mention that it can be triggered by triple quotes and after specifying decorators.
* Use singular, we are talking about the access (GH-7727)Andrés Delfino2018-06-161-1/+1
|