summaryrefslogtreecommitdiffstats
path: root/Doc/glossary.rst
Commit message (Collapse)AuthorAgeFilesLines
* bpo-38056: overhaul Error Handlers section in codecs documentation (GH-15732)Miss Islington (bot)2022-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> (cherry picked from commit 5bc2390229bbcb4f13359e867fd8a140a1d5496b) Co-authored-by: Ma Lin <animalize@users.noreply.github.com>
* bpo-43698: do not use `...` as argument name in docs (GH-30502)Miss Islington (bot)2022-01-261-2/+2
| | | | | (cherry picked from commit b9d8980d89bfaa4bf16d60f0488adcc9d2cbf5ef) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [doc] bpo-45680: Improve glossary entry for generic types (GH-29388) (GH-29448)Miss Islington (bot)2021-11-061-4/+5
| | | | | | Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 77a2c77c84d2ead2d19f96df862c119308e90071) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* bpo-44693: Update __future__ entry in Doc/glossary.rst (GH-27349) (GH-27358)Miss Islington (bot)2021-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> (cherry picked from commit 0363a4014d90df17a29042de008ef0b659f92505) Co-authored-by: Steven Hsu <hsuhaochun@gmail.com> Co-authored-by: Steven Hsu <hsuhaochun@gmail.com>
* [3.9] bpo-41805: Documentation for PEP 585 (GH-22615) (GH-23016)kj2020-10-281-0/+7
| | | Backport of #22615 to 3.9 since that couldn't be auto-merged due to conflicts.
* bpo-29981: Add examples and update index for set, dict, and generator ↵Miss Skeleton (bot)2020-10-251-0/+12
| | | | | | | | comprehensions'(GH-20272) Co-authored-by: Rémi Lapeyre <remi.lapeyre@henki.fr> (cherry picked from commit 2d55aa9e37c9c84f4f6a8135d0326da0bcd8f38b) Co-authored-by: Florian Dahlitz <f2dahlitz@freenet.de>
* [doc] Fix link to abc.ABCMeta.register in Glossary (GH-22932)Miss Skeleton (bot)2020-10-251-1/+1
| | | | | (cherry picked from commit e01e442125bbc98e6dab66f38ecc6c45f69e6587) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* Create a primer section for the descriptor howto guide (GH-22906) (GH0-22918)Miss Skeleton (bot)2020-10-231-1/+2
|
* [doc] Leverage the fact that the actual types can now be indexed for typing ↵Miss Islington (bot)2020-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 (cherry picked from commit d9ab95ff1fe81efdf70e545d536d9f6927d1ba81) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* [3.9] bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) (GH-21901)Victor Stinner2020-08-191-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the c_warn_on_allowed_pre_v3 option to make the documentation compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 423e77d6de497931585d1883805a9e3fa4096b0b) * bpo-40204: Fix Sphinx sytanx in howto/instrumentation.rst (GH-21858) Use generic '.. object::' to declare markers, rather than abusing '.. c:function::' which fails on Sphinx 3. (cherry picked from commit 43577c01a2ab49122db696e9eaec6cb31d11cc81) * bpo-40204: Fix duplicates in the documentation (GH-21857) Fix two Sphinx 3 issues: Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'. Declaration is 'PyBUF_ND'. Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'. Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'. (cherry picked from commit 46d10b1237c67ff8347f533eda6a5468d098f7eb) * bpo-40204: Add :noindex: in the documentation (GH-21859) Add :noindex: to duplicated documentation to fix "duplicate object description" errors. For example, fix this Sphinx 3 issue: Doc/library/configparser.rst:1146: WARNING: duplicate object description of configparser.ConfigParser.optionxform, other instance in library/configparser, use :noindex: for one of them (cherry picked from commit d3ded080482beae578faa704b13534a62d066f9f) * bpo-40204, doc: Fix syntax of C variables (GH-21846) For example, fix the following Sphinx 3 errors: Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters Invalid C declaration: Expected identifier in nested name. [error at 5] void \*obj -----^ Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*' Invalid C declaration: Expected end of definition. [error at 8] PyObject* --------^ The modified documentation is compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 474652fe9346382dbf793f20b671eb74668bebde) * bpo-40204: Fix reference to terms in the doc (GH-21865) 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. (cherry picked from commit bb0b08540cc93e56f3f1bde1b39ce086d9e35fe1) * bpo-40204: Fix duplicated productionlist names in the doc (GH-21900) Sphinx 3 disallows having more than one productionlist markup with the same name. Simply remove names in this case, since names are not shown anyway. For example, fix the Sphinx 3 warning: Doc/reference/introduction.rst:96: duplicate token description of *:name, other instance in reference/expressions (cherry picked from commit 1abeda80f760134b4233608e2c288790f955b95a)
* Improve asyncio.loop.call_soon() documentation (GH-20883)Miss Islington (bot)2020-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> (cherry picked from commit a16d6970496cae5ecab5aaea2b416a4b77527cc2) Co-authored-by: Roger Iyengar <ri@rogeriyengar.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
|
* Remove hyphens from phrase "picks up where it left off" (GH-7410)Andrés Delfino2018-06-101-3/+3
|
* Fix typo spotted by Guido (GH-7131)Andrés Delfino2018-05-261-1/+1
|
* bpo-32769: A new take on annotations/type hinting glossary entries (GH-6829)Andrés Delfino2018-05-261-35/+60
|
* Fix lambda parameters being refered as arguments (GH-7037)Andrés Delfino2018-05-221-1/+1
|
* bpo-33580: Make binary/text file glossary entries follow most common "see ↵Andrés Delfino2018-05-201-4/+4
| | | | also" style. (GH-6991)
* bpo-33518: Add PEP entry to documentation glossary (GH-6860)Andrés Delfino2018-05-171-0/+15
|
* bpo-32769: Write annotation entry for glossary (GH-6657)Andrés Delfino2018-05-141-17/+57
| | | | https://bugs.python.org/issue32769
* s/the the/the/ (GH-6287)INADA Naoki2018-03-281-1/+1
|
* String annotations [PEP 563] (#4390)Guido van Rossum2018-01-261-7/+10
| | | | | | | | * Document `from __future__ import annotations` * Provide plumbing and tests for `from __future__ import annotations` * Implement unparsing the AST back to string form This is required for PEP 563 and as such only implements a part of the unparsing process that covers expressions.
* bpo-32377: improve __del__ docs and fix mention about resurrection (#4927)Antoine Pitrou2017-12-191-1/+2
| | | | | | * Fix #32377: improve __del__ docs and fix mention about resurrection * Mention that CPython only calls __del__ once.
* closes bpo-31650: PEP 552 (Deterministic pycs) implementation (#4575)Benjamin Peterson2017-12-091-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | Python now supports checking bytecode cache up-to-dateness with a hash of the source contents rather than volatile source metadata. See the PEP for details. While a fairly straightforward idea, quite a lot of code had to be modified due to the pervasiveness of pyc implementation details in the codebase. Changes in this commit include: - The core changes to importlib to understand how to read, validate, and regenerate hash-based pycs. - Support for generating hash-based pycs in py_compile and compileall. - Modifications to our siphash implementation to support passing a custom key. We then expose it to importlib through _imp. - Updates to all places in the interpreter, standard library, and tests that manually generate or parse pyc files to grok the new format. - Support in the interpreter command line code for long options like --check-hash-based-pycs. - Tests and documentation for all of the above.
* bpo-25910: Fixes redirection from http to https (#4674)Sanyam Khurana2017-12-061-1/+1
|
* bpo-18558: Clarify glossary entry for "Iterable" (#3732)Raymond Hettinger2017-09-251-1/+4
|
* bpo-26947: DOC: clarify wording on hashable in glossary (#948)csabella2017-04-021-3/+3
|
* bpo-29928: Add f-string to the Glossary (GH-864)Mariatta2017-03-301-0/+5
|
* bpo-29746: Update marshal docs to Python 3. (#547)Serhiy Storchaka2017-03-121-0/+7
|
* bpo-29770: remove outdated PYO related info (GH-590)Xiang Zhang2017-03-111-1/+1
|
* Issue #28091: Document PEP 525 & PEP 530.Yury Selivanov2016-12-151-0/+28
| | | | Patch by Eric Appelt.
* Issue #27985: Implement PEP 526 -- Syntax for Variable Annotations.Yury Selivanov2016-09-091-0/+12
| | | | Patch by Ivan Levkivskyi.
* Issue #27285: Document the deprecation of the pyvenv script.Brett Cannon2016-07-081-1/+1
| | | | | | | | | As part of the update, the documentation was updated to normalize around the term "virtual environment" instead of relying too heavily on "venv" for the same meaning and leading to inconsistent usage of either. Thanks to Steve Piercy for the patch.
* Issue #27186: Define what a "path-like object" is.Brett Cannon2016-06-241-0/+10
| | | | Thanks to Dusty Phillips for the initial patch.