Raymond Hettinger
7117074410
bpo-38096: Clean up the "struct sequence" / "named tuple" docs (GH-15895)
...
* bpo-38096: Clean up the "struct sequence" / "named tuple" docs
* Fix remaining occurrences of "struct sequence"
* Repair a user visible docstring
2019-09-11 15:17:32 +01:00
Julien Palard
0811f2d81a
Doc: Space breaking whole definition. (GH-13615)
2019-05-28 14:04:42 +02:00
Raymond Hettinger
cc1c582f6f
bpo-37051: Refine note on what objects are hashable (GH-13587)
2019-05-27 10:21:31 -07:00
Vinodhini Balusamy
c0a1a07c7e
bpo-32995 - Added context variable in glossary (GH-9741)
2019-05-14 08:11:41 -04:00
Sanyam Khurana
90fb04c1e2
bpo-36822: Fix minor grammatical error in glossary.rst (GH-13145)
2019-05-11 20:04:10 +01:00
Andre Delfino
f760610bdd
bpo-33832: Add "magic method" glossary entry (GH-7630)
2019-03-26 21:21:27 -04:00
Serhiy Storchaka
2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)
2018-12-19 08:09:46 +02:00
Sebastián Ramírez
25221b3283
Fix typo in asynchronous generator iterator documentation (GH-10542)
...
Remove an unnecessary "that":
... will execute that the body ... -> ... will execute the body ...
2018-11-14 21:51:56 -08:00
Windson yang
a9655b7f71
Improve grammar in Glossary. (GH-10474)
...
a asynchronous generator -> an asynchronous generator
2018-11-12 09:42:38 -08:00
Pablo Galindo
b4db249c95
bpo-9842: Add cross-reference to the ellipsis object (GH-4063)
...
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
2018-11-04 14:36:25 -08:00
Stéphane Wirtel
e483f02423
bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)
2018-10-26 12:52:11 +02:00
Zachary Ware
98b976a2f8
Fix struct sequence glossary entry grammar (GH-9030)
...
... by removing a superfluous "either".
Reported by Никита Люшненко on docs@.
2018-09-01 20:59:27 -05:00
Andrés Delfino
cf2c5e8e28
Improve grammar of asynchronous iterator glossary entry (GH-8657)
2018-08-09 08:45:41 -07:00
Andrés Delfino
6868003514
bpo-33571: Improve the glossary description for '...' prompt (GH-6971)
...
Mention that it can be triggered by triple quotes and after specifying decorators.
2018-06-15 20:46:38 -07:00
Andrés Delfino
7469ff5017
Use singular, we are talking about the access (GH-7727)
2018-06-15 19:42:09 -07:00
Andrés Delfino
d689f97619
Remove hyphens from phrase "picks up where it left off" (GH-7410)
2018-06-09 18:43:45 -07:00
Andrés Delfino
2298c0e6a6
Fix typo spotted by Guido (GH-7131)
2018-05-26 11:18:02 -07:00
Andrés Delfino
6e33f810c9
bpo-32769: A new take on annotations/type hinting glossary entries (GH-6829)
2018-05-26 05:43:39 -07:00
Andrés Delfino
268cc7c3f8
Fix lambda parameters being refered as arguments (GH-7037)
2018-05-22 07:57:45 +02:00
Andrés Delfino
0c4be82890
bpo-33580: Make binary/text file glossary entries follow most common "see also" style. (GH-6991)
2018-05-20 18:12:50 +03:00
Andrés Delfino
d5f1442608
bpo-33518: Add PEP entry to documentation glossary (GH-6860)
2018-05-17 09:51:50 +02:00
Andrés Delfino
f2290fb19a
bpo-32769: Write annotation entry for glossary (GH-6657)
...
https://bugs.python.org/issue32769
2018-05-14 15:04:55 -04:00
INADA Naoki
40a536be53
s/the the/the/ (GH-6287)
2018-03-28 22:07:57 +09:00
Guido van Rossum
95e4d58913
String annotations [PEP 563] ( #4390 )
...
* 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.
2018-01-26 08:20:18 -08:00
Antoine Pitrou
4b965930e8
bpo-32377: improve __del__ docs and fix mention about resurrection ( #4927 )
...
* Fix #32377 : improve __del__ docs and fix mention about resurrection
* Mention that CPython only calls __del__ once.
2017-12-19 19:48:45 +01:00
Benjamin Peterson
42aa93b8ff
closes bpo-31650: PEP 552 (Deterministic pycs) implementation ( #4575 )
...
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.
2017-12-09 10:26:52 -08:00
Sanyam Khurana
1b4587a246
bpo-25910: Fixes redirection from http to https ( #4674 )
2017-12-06 17:39:33 +01:00
Raymond Hettinger
0bf287b6e0
bpo-18558: Clarify glossary entry for "Iterable" ( #3732 )
2017-09-25 00:52:06 -07:00
csabella
64c887ab3a
bpo-26947: DOC: clarify wording on hashable in glossary ( #948 )
2017-04-01 19:50:47 -07:00
Mariatta
33db068dac
bpo-29928: Add f-string to the Glossary (GH-864)
2017-03-30 12:12:18 -07:00
Serhiy Storchaka
c611a5b1d4
bpo-29746: Update marshal docs to Python 3. ( #547 )
2017-03-12 08:53:22 +02:00
Xiang Zhang
0710d75425
bpo-29770: remove outdated PYO related info (GH-590)
2017-03-11 13:02:52 +08:00
Yury Selivanov
03660041d2
Issue #28091 : Document PEP 525 & PEP 530.
...
Patch by Eric Appelt.
2016-12-15 17:36:05 -05:00
Yury Selivanov
f8cb8a16a3
Issue #27985 : Implement PEP 526 -- Syntax for Variable Annotations.
...
Patch by Ivan Levkivskyi.
2016-09-08 20:50:03 -07:00
Brett Cannon
15552c39e0
Issue #27285 : Document the deprecation of the pyvenv script.
...
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.
2016-07-08 10:46:21 -07:00
Brett Cannon
c28592bb2f
Issue #27186 : Define what a "path-like object" is.
...
Thanks to Dusty Phillips for the initial patch.
2016-06-24 12:21:47 -07:00
Berker Peksag
6bf8e61984
Merge from 3.5
2016-06-11 22:41:03 +03:00
Berker Peksag
af51140fa0
Fix typo and silence a Sphinx warning in Doc/glossary.rst
2016-06-11 22:40:41 +03:00
Serhiy Storchaka
f41b82fb19
Issue #26282 : PyArg_ParseTupleAndKeywords() and Argument Clinic now support
...
positional-only and keyword parameters in the same function.
2016-06-09 16:30:29 +03:00
Yury Selivanov
a6f6edbda8
Issue #27243 : Fix __aiter__ protocol
2016-06-09 15:08:31 -04:00
Martin Panter
46f50726a0
Issue #27076 : Doc, comment and tests spelling fixes
...
Most fixes to Doc/ and Lib/ directories by Ville Skyttä.
2016-05-26 05:35:26 +00:00
Senthil Kumaran
3858a1c18c
Issue23675 - A tiny clarification in the MRO glossary term.
2016-01-09 22:33:54 -08:00
Brett Cannon
ccddbb186b
Issue #23936 : Clarify what finders are.
...
Thanks to Raúl Cumplido for the bug report and Thomas Kluyver for the
patch.
2015-12-04 15:46:21 -08:00
Martin Panter
84835ab1cb
Issue #25161 : Merge full stops from 3.4 into 3.5
2015-10-10 10:44:25 +00:00
Martin Panter
d21e0b52f1
Issue #25161 : Add full stops in documentation; patch by Takase Arihiro
2015-10-10 10:36:22 +00:00
Martin Panter
446977c080
Issue #25286 : Merge dictionary view glossary from 3.4 into 3.5
2015-10-07 10:01:04 +00:00
Martin Panter
85b8f45515
Issue #25286 : Dictionary views are not sequences
...
Also change glossary heading from view
2015-10-07 09:56:46 +00:00
Stefan Krah
70e543b266
Issue #23756 : Clarify the terms "contiguous" and "bytes-like object".
...
Patch by Martin Panter.
2015-08-08 14:33:28 +02:00
Yury Selivanov
66f8828bfc
Issue #24439 : Improve PEP 492 related docs.
...
Patch by Martin Panter.
2015-06-24 11:04:15 -04:00
Yury Selivanov
5376ba9630
Issue #24400 : Introduce a distinct type for 'async def' coroutines.
...
Summary of changes:
1. Coroutines now have a distinct, separate from generators
type at the C level: PyGen_Type, and a new typedef PyCoroObject.
PyCoroObject shares the initial segment of struct layout with
PyGenObject, making it possible to reuse existing generators
machinery. The new type is exposed as 'types.CoroutineType'.
As a consequence of having a new type, CO_GENERATOR flag is
no longer applied to coroutines.
2. Having a separate type for coroutines made it possible to add
an __await__ method to the type. Although it is not used by the
interpreter (see details on that below), it makes coroutines
naturally (without using __instancecheck__) conform to
collections.abc.Coroutine and collections.abc.Awaitable ABCs.
[The __instancecheck__ is still used for generator-based
coroutines, as we don't want to add __await__ for generators.]
3. Add new opcode: GET_YIELD_FROM_ITER. The opcode is needed to
allow passing native coroutines to the YIELD_FROM opcode.
Before this change, 'yield from o' expression was compiled to:
(o)
GET_ITER
LOAD_CONST
YIELD_FROM
Now, we use GET_YIELD_FROM_ITER instead of GET_ITER.
The reason for adding a new opcode is that GET_ITER is used
in some contexts (such as 'for .. in' loops) where passing
a coroutine object is invalid.
4. Add two new introspection functions to the inspec module:
getcoroutinestate(c) and getcoroutinelocals(c).
5. inspect.iscoroutine(o) is updated to test if 'o' is a native
coroutine object. Before this commit it used abc.Coroutine,
and it was requested to update inspect.isgenerator(o) to use
abc.Generator; it was decided, however, that inspect functions
should really be tailored for checking for native types.
6. sys.set_coroutine_wrapper(w) API is updated to work with only
native coroutines. Since types.coroutine decorator supports
any type of callables now, it would be confusing that it does
not work for all types of coroutines.
7. Exceptions logic in generators C implementation was updated
to raise clearer messages for coroutines:
Before: TypeError("generator raised StopIteration")
After: TypeError("coroutine raised StopIteration")
2015-06-22 12:19:30 -04:00
Yury Selivanov
a18cad543f
Issue 24180: Fixes by Berker Peksag.
2015-05-21 17:02:31 -04:00
Yury Selivanov
f3e40fac10
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
Larry Hastings
ab792ac704
Doc clarification / edification on the semantics of the 'w*' format unit.
2015-04-13 11:30:56 -04:00
Georg Brandl
0443c92ee1
merge with 3.4
2015-01-15 08:16:25 +01:00
Georg Brandl
caa12dab69
Closes #23244 : fix typo. Thanks Mayank Tripathi for the patch.
2015-01-15 08:16:01 +01:00
Nick Coghlan
582acb75e9
Merge issue 19548 changes from 3.4
2015-01-07 00:37:01 +10:00
Nick Coghlan
b9fdb7a452
Issue 19548: update codecs module documentation
...
- clarified the distinction between text encodings and other codecs
- clarified relationship with builtin open and the io module
- consolidated documentation of error handlers into one section
- clarified type constraints of some behaviours
- added tests for some of the new statements in the docs
2015-01-07 00:22:00 +10:00
Antoine Pitrou
5db1bb81ff
Issue #22696 : Add function :func:`sys.is_finalizing` to know about interpreter shutdown.
2014-12-07 01:28:27 +01:00
Georg Brandl
cadc3fdcb5
Merge with 3.4
2014-10-29 08:37:29 +01:00
Georg Brandl
e73778c1ac
Use https:// URLs when referring to python.org hosts.
2014-10-29 08:36:35 +01:00
Georg Brandl
033ec051f8
merge with 3.4
2014-10-06 16:48:38 +02:00
Georg Brandl
4dd27a3edb
Closes #21782 : the default hash(x) is not exactly id(x) but derived from it.
2014-10-06 16:45:23 +02:00
Nick Coghlan
4a4b679515
Merge issue #22295 fix from 3.4
2014-09-06 20:40:00 +10:00
Nick Coghlan
1d52096d14
Issue #22295 : Adopt 'python -m pip' as the preferred invocation
2014-09-06 20:38:23 +10:00
Terry Jan Reedy
8d2d8894da
Merge with 3.4
2014-08-23 18:29:02 -04:00
Terry Jan Reedy
004e87048a
Issue #22232 (partial fix): update Universal newlines Glossary entry.
2014-08-23 18:28:44 -04:00
Raymond Hettinger
35db43955c
Issue #13742 : Add key and reverse parameters to heapq.merge()
2014-05-30 02:28:36 -07:00
Larry Hastings
3732ed2414
Merge in all documentation changes since branching 3.4.0rc1.
2014-03-15 21:13:56 -07:00
Andrew Kuchling
a3d0ffe2c6
Merge from 3.3
2014-02-15 17:22:41 -05:00
Andrew Kuchling
cb3ff4468a
#16728 : Mention collections.abc.Sequence in 'sequence' glossary entry
2014-02-15 17:05:26 -05:00
Eric Snow
ca2d854df8
Issue #19713 : Update importlib docs for module spec changes, including deprecations.
2013-12-16 23:06:52 -07:00
Antoine Pitrou
710280b6d6
Issue #18840 : Introduce the json module in the tutorial, and deemphasize the pickle module.
2013-12-05 23:48:10 +01:00
Antoine Pitrou
dd799d2e32
Issue #18840 : Introduce the json module in the tutorial, and deemphasize the pickle module.
2013-12-05 23:46:32 +01:00
Zachary Ware
e19e3f0b91
Issue #18326 : merge with 3.3
2013-11-22 14:03:10 -06:00
Zachary Ware
e1391a0d68
Issue #18326 : Clarify that list.sort's arguments are keyword-only.
...
Also, attempt to reduce confusion in the glossary by not saying there are
different "types" of arguments and parameters.
2013-11-22 13:58:34 -06:00
Nick Coghlan
4dae27a08d
Tweak 'provisional' in glossary
2013-10-20 13:22:04 +10:00
Serhiy Storchaka
0d85b5c68d
Issue #19190 : Improve cross-references in builtin types and functions documentation.
2013-10-09 14:03:24 +03:00
Serhiy Storchaka
0d196edc37
Issue #19190 : Improve cross-references in builtin types and functions documentation.
2013-10-09 14:02:31 +03:00
Georg Brandl
245c765d0a
merge with 3.3
2013-10-08 08:06:27 +02:00
Georg Brandl
bcce1256e3
Closes #19178 : some more cross-references about packages in glossary. Patch by Berker Peksag.
2013-10-08 08:06:18 +02:00
Georg Brandl
7e41547c47
merge with 3.3
2013-10-06 11:57:23 +02:00
Georg Brandl
60e602dcc6
Fix small grammar mistake.
2013-10-06 11:57:13 +02:00
Łukasz Langa
fdcf2b7d4e
moved the single-dispatch generic function definitions to the glossary
2013-06-07 22:54:03 +02:00
R David Murray
25cd09115d
#14187 : Add glossary entry for 'function annotations'.
...
Patch by Chris Rebert.
2013-05-06 12:58:16 -04:00
Antoine Pitrou
5de183a07c
Elaborate on bytes-like objects.
2013-05-04 20:18:34 +02:00
Ezio Melotti
aa54e2ff5e
#16518 : add "bytes-like object" to the glossary.
2013-04-30 23:33:31 +03:00
Ezio Melotti
84ad6aea73
#16128 : merge with 3.2.
2013-02-01 05:20:06 +02:00
Ezio Melotti
188ad851fb
#16128 : clarify that instances of user-defined classes compare equal with themselves.
2013-02-01 05:18:44 +02:00
Ezio Melotti
407c2ac4f7
#16747 : merge with 3.2.
2013-01-02 22:29:41 +02:00
Ezio Melotti
d581fff6f0
#16747 : fix link to file objects in the glossary.
2013-01-02 22:29:09 +02:00
Chris Jerdonek
32bbc1c396
Merge from 3.2: add links and index entries for "argument" and "parameter."
...
This adds to the work done for issue #15990 (i.e. f44b8d69e5fc and the
commits referenced there).
2012-12-25 14:57:54 -08:00
Chris Jerdonek
b43099464a
Add additional links and index entries for "argument" and "parameter".
...
This adds to the work done for issue #15990 (i.e. f44b8d69e5fc and the
commits referenced there).
2012-12-25 14:54:44 -08:00
Chris Jerdonek
d97c71feda
Merge from 3.2: improve argument/parameter documentation (issue #15990 ).
2012-11-28 02:37:42 -08:00
Chris Jerdonek
c2a7fd60e1
Improve argument/parameter documentation (issue #15990 ).
...
This commit adds "parameter" to the glossary, improves and consolidates the
"argument" glossary entry, and adds a question to the FAQ on the difference
between arguments and parameters.
2012-11-28 02:29:33 -08:00
Benjamin Peterson
143d034ecd
merge 3.2
2012-10-12 12:04:32 -04:00
Ezio Melotti
7fa822275b
Fix links to the __next__ method.
2012-10-12 13:42:08 +03:00
Andrew Svetlov
fd03a099d8
Merge issue #16138 : fix typo.
2012-10-05 13:26:42 +03:00
Andrew Svetlov
8cf1cc498f
Issue #16138 : fix typo.
2012-10-05 13:26:10 +03:00
Nick Coghlan
1685db011d
s/path importer/path based finder/ (because the path based finder is not an importer and the simpler 'path finder' is too ambiguous)
2012-08-20 13:49:08 +10:00
R David Murray
27bbcfb8ff
Merge #15543 : glossary entry for and 'universal newlines', and links to it.
...
Patch by Chris Jerdonek.
2012-08-15 11:11:27 -04:00