Victor Stinner
1abeda80f7
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
2020-08-17 08:41:42 +02:00
Victor Stinner
bb0b08540c
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.
2020-08-14 12:20:05 +02:00
amaajemyfren
13efaec2e0
bpo-41045: Document debug feature of f-strings ('=') (GH-21509)
...
Co-Authored-By: Rishi <rishi93dev@gmail.com>
Automerge-Triggered-By: @gvanrossum
2020-07-27 15:31:02 -07:00
Pablo Galindo
72cabb2aa6
bpo-40939: Use the new grammar for the grammar specification documentation (GH-19969)
...
(We censor the heck out of actions and some other stuff using a custom "highlighter".)
Co-authored-by: Guido van Rossum <guido@python.org>
2020-07-27 11:20:36 -07:00
Shankar Jha
f117cef25b
bpo-39868: Add documentation for Assignment Expressions (walrus, PEP 572) ( #18851 )
2020-07-25 16:33:48 -07:00
Andre Delfino
b9f6ac9d46
Stick with the phrase "default parameter value" (GH-21590)
2020-07-22 20:58:19 -03:00
Géry Ogam
e2fb8a2c42
Update lexical_analysis.rst (GH-17508)
...
Use Sphinx role markup for `str.format`.
Automerge-Triggered-By: @csabella
2020-06-12 05:54:29 -07:00
Matteo Bertucci
af23f0d3cf
bpo-40439: Update broken link in lexical analysis docs (GH-20184)
...
Automerge-Triggered-By: @csabella
2020-05-22 18:12:09 -07:00
Heshy Roskes
ef33712baa
Fix typo in object.__format__ docs (GH-19504)
2020-04-25 21:57:09 -04:00
Mark Dickinson
810f68f128
Fix misinformation about NaN != NaN comparison (GH-19357)
2020-04-05 10:25:24 +01:00
Mathieu Dupuy
c49016e67c
fix comma location in various places (GH-19233)
2020-03-30 14:28:25 -07:00
Javad Mokhtari
5f9c131c09
bpo-40045: Make "dunder" method documentation easier to locate ( #19153 )
...
* issue 40045
* Update lexical_analysis.rst
Make "dunder" method documentation easier(GH-19153)
Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
2020-03-27 16:02:51 -03:00
Lahfa Samy
59c644eaa7
bpo-39879: Update datamodel docs to include dict ordering (GH-19006)
...
Co-authored-by: furkanonder <furkantahaonder@gmail.com>
2020-03-26 09:54:04 -05:00
Benjamin Peterson
51796e5d26
Update some www.unicode.org URLs to use HTTPS. (GH-18912)
2020-03-10 21:10:59 -07:00
Benjamin Peterson
051b9d08d1
closes bpo-39926: Update Unicode to 13.0.0. (GH-18910)
2020-03-10 20:41:34 -07:00
Brandt Bucher
8f13053692
bpo-39702: Update the Language Reference (PEP 614) (GH-18802)
2020-03-07 10:23:49 -08:00
Caleb Donovick
e59334ebc9
bpo-17422: slightly more precise language (GH-18682)
2020-03-06 10:20:48 -08:00
Brandt Bucher
8bae21962b
bpo-39868: Update Language Reference for PEP 572. ( #18793 )
2020-03-05 21:19:22 -08:00
MojoVampire
469325c30e
bpo-35712: Make using NotImplemented in a boolean context issue a deprecation warning (GH-13195)
2020-03-03 20:50:17 +02:00
ananthan-123
fbe2e0bb8a
bpo-17422: Language reference should specify restrictions on class namespace ( #18559 )
...
The language reference now specifies restrictions on class namespaces. Adapted from a patch by Ethan Furman.
2020-02-22 09:56:01 -08:00
Serhiy Storchaka
f632736023
bpo-39545: Document changes in the support of await in f-strings. (GH-18456)
...
https://bugs.python.org/issue39545
2020-02-13 15:57:35 -08:00
Bonifacio de Oliveira
d47d0c8e9f
Improve grammar in the import system reference documentation (GH-18209)
...
Replaced the period with a comma.
Automerge-Triggered-By: @Mariatta
2020-01-29 18:23:50 -08:00
alclarks
7de617455e
bpo-15243: Document __prepare__ as classmethod (GH-17124)
2020-01-25 21:49:58 +03:00
Géry Ogam
1d1b97ae64
bpo-39048: Look up __aenter__ before __aexit__ in async with (GH-17609)
...
* Reorder the __aenter__ and __aexit__ checks for async with
* Add assertions for async with body being skipped
* Swap __aexit__ and __aenter__ loading in the documentation
2020-01-14 21:58:29 +10:00
HongWeipeng
abc0c4fa99
Fix the parameter list of object. _rpow_ (#GH-16477)
2020-01-05 17:20:29 -05:00
Géry Ogam
226e6e7d43
bpo-39037: Fix lookup order of magic methods in with statement documentation (GH-17608)
...
* __enter__ is now looked up before __exit__ to give a more intuitive error message
* add pseudo-code equivalent for the with statement
* fix pseudo-code for the async with statement to use a finally clause
* use SUITE rather than BLOCK for consistency with the language grammar
Patch by Géry Ogam.
2019-12-30 15:24:51 +10:00
Oleg Höfling
cbd0408b54
links in importlib.metadata.rst replaced with sphinx references (GH-17730)
...
The importlib.metadata documentation uses hardcoded links to internal
pages. This results in minor rendering issues. This change replaces
the hardcoded links with suitable Sphinx roles.
Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
2019-12-29 12:26:35 -05:00
Batuhan Taşkaya
d587272fe3
bpo-38316: Fix co_stacksize documentation (GH-16983)
2019-12-15 23:02:47 +01:00
Tal Einat
02519f75d1
bpo-38524: clarify example a bit and improve formatting (GH-17406)
2019-11-28 07:22:09 +02:00
Florian Dahlitz
1bddf890e5
bpo-38524: document implicit and explicit calling of descriptors' __set_name__ (GH-17364)
2019-11-27 10:46:40 +02:00
alclarks
4544e78ec4
bpo-25866: Minor cleanups to "sequence" in docs (GH-17177)
2019-11-17 14:00:43 -08:00
Shu
2d56af7a94
Fix minor typos. (GH-17095)
2019-11-12 19:12:11 -08:00
Shu
fc6b1bf869
Clarify amount of dots between package and subpackage (GH-17092)
2019-11-08 12:26:35 -08:00
Géry Ogam
4c155f738d
bpo-38336: Remove the __set__ method restriction on data descriptors for attribute lookup precedence (GH-16520)
2019-10-29 00:04:01 -07:00
Steve Dower
894e30ce0b
bpo-38434: Fixes some audit event documentation (GH-16932)
2019-10-26 13:02:30 -07:00
Julien Palard
a45b0efdea
Doc: Add -m reference in context of code execution (GH-16045)
2019-09-12 14:19:06 +01:00
Emily Morehouse
6357c95716
bpo-35224: Additional documentation for Assignment Expressions (GH-15935)
...
Add or update assignment expression documentation for:
- FAQ - Design
- Reference - Expressions
- Reference - Lexical Analysis
https://bugs.python.org/issue35224
Automerge-Triggered-By: @matrixise
2019-09-11 07:37:12 -07:00
Andre Delfino
dc26997109
bpo-33459: Fix "tuple displays" term in Expressions.rst (GH-6760)
...
https://bugs.python.org/issue33459
Automerge-Triggered-By: @matrixise
2019-09-11 06:16:11 -07:00
Steve Dower
a39a4c7439
bpo-37913: Link to NotImplemented from new docs (GH-15860)
2019-09-10 15:25:12 +01:00
Jeroen Demeyer
009ef2955d
bpo-37913: document that __length_hint__ can return NotImplemented (GH-15383)
2019-09-10 15:01:13 +01:00
Raymond Hettinger
0dac68f1e5
bpo-36743: __get__ is sometimes called without the owner argument ( #12992 )
2019-08-29 01:27:42 -07:00
Joannah Nanjekye
6b16d938d6
bpo-15542: Documentation incorrectly suggests __init__ called after direct __new__ call (GH-15478)
2019-08-25 23:53:11 -07:00
Raymond Hettinger
edd21129dd
bpo-32118: Simplify docs for sequence comparison (GH-15450)
2019-08-24 10:43:55 -07:00
Serhiy Storchaka
e9c90aa431
bpo-29535: Remove promize about hash randomization of datetime objects. (GH-15269)
2019-08-24 12:49:27 +03:00
Gregory P. Smith
b4be87a04a
bpo-32912: Revert SyntaxWarning on invalid escape sequences. (GH-15195)
...
DeprecationWarning will continue to be emitted for invalid escape
sequences in string and bytes literals just as it did in 3.7.
SyntaxWarning may be emitted in the future. But per mailing list
discussion, we don't yet know when because we haven't settled on how to
do so in a non-disruptive manner.
(Applies 4c5b6bac24
to the master branch).
(This is https://github.com/python/cpython/pull/15142 for master/3.9)
https://bugs.python.org/issue32912
Automerge-Triggered-By: @gpshead
2019-08-10 00:19:07 -07:00
Jörn Heissler
c8a35417db
bpo-35224: Reverse evaluation order of key: value in dict comprehensions (GH-14139)
...
… as proposed in PEP 572; key is now evaluated before value.
https://bugs.python.org/issue35224
2019-06-22 07:40:55 -07:00
Ivan Levkivskyi
8bcf2629a2
More updates to the annotated assignments docs (GH-13794)
2019-06-04 11:37:46 +01:00
Ivan Levkivskyi
82eac26a73
Update the annotated assignment docs (GH-13757)
2019-06-03 00:41:00 +01:00
Serhiy Storchaka
bdbad71b9d
bpo-20092. Use __index__ in constructors of int, float and complex. (GH-13108)
2019-06-02 00:05:48 +03:00
Pablo Galindo
cd74e66a8c
bpo-37122: Make co->co_argcount represent the total number of positonal arguments in the code object (GH-13726)
2019-06-01 18:08:04 +01:00
Serhiy Storchaka
70c5f2ae6e
Use more PEP 570 syntax in the documentation. (GH-13720)
2019-06-01 11:38:24 +03:00
Pablo Galindo
ed222a74a0
Update data model docs to include missing attributes for code objects (GH-13696)
...
Include and document co_posonlyargcount and co_kwonlyargcount
2019-05-31 12:13:04 +01:00
Antti Haapala
2f5b9dcc0a
bpo-30969: Fix docs about the comparison in absence of __contains__ (GH-2761)
2019-05-30 16:19:28 -04:00
Pablo Galindo
29cb21ddb9
Regenerate topics file (GH-13642)
2019-05-29 22:59:00 +01:00
Pablo Galindo
b76302ddd0
bpo-36540: Documentation for PEP570 - Python positional only arguments ( #13202 )
...
* bpo-36540: Documentation for PEP570 - Python positional only arguments
* fixup! bpo-36540: Documentation for PEP570 - Python positional only arguments
* Update reference for compound statements
* Apply suggestions from Carol
Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>
* Update Doc/tutorial/controlflow.rst
Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>
* Add extra bullet point and minor edits
2019-05-28 16:45:32 -07:00
divyag9
778a910758
bpo-34682: Wording and grammatical changes to the doc( https://docs.python.org/3 ) (GH-13120)
...
https://bugs.python.org/issue34682
2019-05-13 06:05:20 -07:00
Johnny Gérard
4ef9b8e505
Correct misspelling (GH-11470)
2019-05-12 23:39:32 -04:00
Benjamin Peterson
3aca40d3cb
closes bpo-36861: Update Unicode database to 12.1.0. (GH-13214)
...
Adds ㋿.
2019-05-08 20:59:35 -07:00
Logan Jones
ae2c32f32b
bpo-36798: Updating f-string docs for := use case (GH-13107)
2019-05-06 11:32:44 -05:00
Catherine Alvarado
5e98f05e55
bpo-36166: Change to rst datamodel file. (GH-13089)
2019-05-04 17:54:35 -04:00
Andre Delfino
a8a79cacca
Improve grammar on async context managers and shorten text (GH-12379)
2019-05-03 08:08:10 -07:00
Andre Delfino
5861cddf76
Don't use the LHS/RHS acronym in Simple statements (GH-12996)
...
Prefer the full wording instead, as it is more meaningful for someone not familiar with the terms.
Also, LFS/RHS is not used anywhere else in the documentation, while left/right-hand side mentions are common.
2019-05-03 07:59:05 -07:00
Géry Ogam
ee88af3f4f
Namespace packages _bootstrap.ModuleSpec.loader attributes are no longer None ( #10376 )
...
Namespace packages _bootstrap.ModuleSpec.loader attributes are no longer `None` _after_ calling the importlib._bootstrap._init_module_attrs function.
See:
* https://stackoverflow.com/questions/52869541/namespace-package-spec-loader-and-loader-attributes-not-set-to-none
* https://bugs.python.org/issue35181
2019-05-01 13:08:17 -07:00
Joannah Nanjekye
70bf713617
bpo-30840: Document relative imports ( #12831 )
...
* document relative imports
* 📜 🤖 Added by blurb_it.
* fix indentation error
* remove indentation
* Document relative imports
* Document relative imports
* remove from ...package
* Document relative imports
* remove trailing space
* Document relative imports
* Document relative imports
2019-04-25 01:14:44 +10:00
Jules Lasne (jlasne)
1fc5bf2ff2
Doc: Fixed missing punctuation in datamodel.rst (GH-12581)
2019-03-27 11:10:33 +01:00
Benjamin Peterson
738c19f4c5
closes bpo-33376: Update to Unicode 12.0.0. (GH-12256)
2019-03-09 16:25:55 -08:00
Martijn Pieters
b727239575
closes bpo-36188: Clean up 'unbound' method left-overs. (GH-12169)
...
Methods are always bound, and `__self__` can no longer be `NULL`
(`method_new()` and `PyMethod_New()` both explicitly check for this).
Moreover, once a bound method is bound, it *stays* bound and won't be re-bound
to something else, so the section in the datamodel that talks about accessing
an methods in a different descriptor-binding context doesn't apply any more in
Python 3.
2019-03-04 21:19:34 -08:00
Raymond Hettinger
7463884f69
Document other performance implication for __slots__ (GH-11974)
2019-02-21 03:34:04 -08:00
Pierre Glaser
df8d2cde63
bpo-35911: add cell constructor (GH-11771)
...
Add a cell constructor, expose the cell type in the types module.
2019-02-07 19:36:48 +00:00
Cheryl Sabella
b7105c9c96
bpo-35566: Add links to annotation glossary term (GH-11291)
2018-12-23 21:09:09 -08:00
Serhiy Storchaka
2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)
2018-12-19 08:09:46 +02:00
Andre Delfino
55f41e45b4
Correct a couple of unbalanced parenthesis. (GH-10779)
2018-12-05 21:45:30 +02:00
Andre Delfino
1ce853f377
Move __missing__ after __delitem__ in Data model. (GH-10923)
2018-12-05 21:42:44 +02:00
wim glenn
a48e0eb967
Fix outdated info in datamodel about dicts (GH-9807)
2018-11-16 20:58:19 +09:00
Andrés Delfino
c2ccac7b9f
bpo-33816: Remove outdated metaclass example (GH-7566)
2018-11-16 20:41:55 +09:00
Julien Palard
082875dcd6
bpo-33878: Doc: Fix missing case by simplifying. (GH-7762)
...
The documentation was not covering multiple targets enclosed by
parenthesis nor multiple targets enclosed by brackets, adding them all
would be heavy, an else cover them all and is lighter to read.
2018-11-12 00:59:39 +01:00
Andrés Delfino
b086c8afdb
bpo-33699: Describe try's else clause with the rest of the try clause (GH-7252)
...
https://bugs.python.org/issue33699
2018-11-11 11:33:51 -08:00
Andrés Delfino
bfe1839aa9
Add link to PEP 525 in Expressions. (GH-10333)
2018-11-07 20:12:12 +02:00
Andrés Delfino
cdb96f45b6
Add future_stmt to simple_stmt production list. (GH-8239)
2018-11-07 19:32:18 +02:00
Andrés Delfino
ea6a28c9f7
Mark -c and -O as command line options in reStructuredText. (GH-10103)
2018-11-07 19:06:45 +02:00
Denis Osipov
0bee3c36d4
bpo-35119: Fix RecursionError in example of customizing module attribute access. (GH-10323)
...
https://bugs.python.org/issue35119
2018-11-06 01:53:21 +00:00
Serhiy Storchaka
913876d824
bpo-35054: Add yet more index entries for symbols. (GH-10121)
2018-10-28 13:41:26 +02:00
Andrés Delfino
95f68b10d5
Fix mistakes on function coroutines related definitions (GH-9871)
...
Fix a bug I introduced in #9864 by which coroutines are treated as synonymous of function coroutines.
Also, fix the same mistake (coroutines == function coroutines) already present in other parts of the reference.
I'm very sorry for the hassle.
2018-10-28 03:41:57 -07:00
Serhiy Storchaka
ddb961d2ab
bpo-35054: Add more index entries for symbols. (GH-10064)
2018-10-26 09:00:49 +03:00
Andrés Delfino
0f14fc1a7c
bpo-33726, doc: Add short descriptions to PEP references in seealso (GH-7294)
2018-10-20 01:31:15 +02:00
Serhiy Storchaka
6543912c90
bpo-32912: Replace a DeprecationWarning with a SyntaxWarning (GH-9652)
...
for invalid escape sequences in string and bytes literals.
2018-10-19 17:42:06 +03:00
Andrés Delfino
c8bb467f40
Update compound_stmts.rst ( #9864 )
2018-10-14 11:18:16 +03:00
Tony Flury
ad8a000420
closes bpo-28955: Clarified comparisons between NaN and number in reference documentation (GH-5982)
...
Co-authored-by: Benjamin Peterson <benjamin@python.org>
2018-09-14 10:48:50 -07:00
Berker Peksag
3c1b590472
Fix HTML formatting in datamodel.rst (GH-8693)
2018-08-06 23:52:49 +03:00
Andrés Delfino
6921ef7bef
Use 'for example' instead of 'in other words' in compound statement doc (GH-8401)
2018-07-30 11:44:35 -07:00
Andrés Delfino
e42b705188
Fix typo: variables(s) (GH-8482)
...
Remove extra `(s)` in the documentation of `compound_stmts`.
2018-07-26 16:35:23 +01:00
Andrés Delfino
caccca78e4
bpo-33702: Add some missing links in production lists and do a little polish (GH-7259)
2018-07-07 23:24:46 +03:00
Andrés Delfino
c9d43c702a
bpo-33877: Remove UNIX qualification for running complete programs (GH-7744)
...
The statement is true for Windows (and macOS) also.
2018-06-22 17:31:03 -04:00
Andrés Delfino
695118600f
bpo-33847: Add '@' operator entry to index (GH-7669)
2018-06-15 15:23:00 -04:00
Andrés Delfino
4fddd4e406
bpo-33852: Remove misplaced parentheses around 'list'. (GH-7672)
...
'expresson list' refers to the grammar term 'expression_list' in the subscription production.
2018-06-15 14:24:25 -04:00
Ammar Askar
0aa17ee6a7
bpo-33766: Document that end of file or string is a newline (GH-7383)
2018-06-09 19:49:39 -04:00
Benjamin Peterson
7c69c1c0fb
update to Unicode 11.0.0 (closes bpo-33778) (GH-7439)
...
Also, standardize indentation of generated tables.
2018-06-06 20:14:28 -07:00
Zach Mitchell
00818c8ffd
Fix typo in datamodel.rst (GH-6964)
...
This is a simple grammatical fix correcting "...object whose `__self__` attributes is ..." to "...object whose `__self__` attribute is ...".
2018-06-02 07:29:47 -07:00
Andrés Delfino
268cc7c3f8
Fix lambda parameters being refered as arguments (GH-7037)
2018-05-22 07:57:45 +02:00
Serhiy Storchaka
f5e7b1999f
bpo-23722: Raise a RuntimeError for absent __classcell__. (GH-6931)
...
A DeprecationWarning was emitted in Python 3.6-3.7.
2018-05-20 08:48:12 +03:00
Serhiy Storchaka
8ae8e6af37
bpo-23722: Fix docs for future __classcell__ changes. (GH-6999)
2018-05-20 08:13:52 +03:00
Elvis Pranskevichus
63536bd286
bpo-32996: The bulk of What's New in Python 3.7 (GH-6978)
2018-05-19 23:15:06 -04:00
Ivan Levkivskyi
bd5f96581b
bpo-32717: Document PEP 560 (GH-6726)
2018-05-08 19:38:41 +01:00
Brett Cannon
441d945eb3
Clarify that __path__ can't be just any value (GH-6554)
2018-04-20 16:32:46 -07:00
Serhiy Storchaka
d08972fdb9
bpo-33260: Regenerate token.py after removing ASYNC and AWAIT. (GH-6447)
2018-04-11 19:15:51 +03:00
Serhiy Storchaka
fe2bbb1869
bpo-32489: Allow 'continue' in 'finally' clause. (GH-5822)
2018-03-18 09:56:52 +02:00
Serhiy Storchaka
496431ffb6
bpo-26701: Improve documentation for the rounding special methods. ( #6054 )
2018-03-10 17:18:32 +02:00
Eric Appelt
308eab979d
bpo-26701: Add documentation for __trunc__ (GH-6022)
...
`int` fails back to `__trunc__` is `__int__` isn't defined, so cover
that in the docs.
2018-03-10 18:44:12 +10:00
Nick Coghlan
aec7532ed3
bpo-30579: Docs for dynamic traceback creation (GH-5653)
2018-02-13 18:10:58 +10:00
Cheryl Sabella
d1f318105b
bpo-8722: Document __getattr__ behavior with AttributeError in property (GH-4754)
...
When `__getattr__` is implemented, attribute lookup will always fall back to that,
even if the initial failure comes from `__getattribute__` or a descriptor's `__get__`
method (including property methods).
2018-02-05 12:03:22 +10:00
Serhiy Storchaka
07ca9afaa8
bpo-10544: Disallow "yield" in comprehensions and generator expressions. (GH-4564)
2018-02-04 10:53:48 +02:00
Cheryl Sabella
b299393cc3
bpo-32735: Fix typo in f-strings datetime format specifier example (GH-5464)
...
The f-string example for using datetime format specifier does not match the given output.
Changed the format from %b to %B so it matches the output of "January".
2018-01-31 16:37:51 -05:00
Cheryl Sabella
85527cf50a
bpo-27505: Add change notes in module attribute docs (GH-5320)
...
Make it clear that setting __class__ on a module has worked since 3.5,
but support for __getattr__ and __dir__ on module instances requires 3.7+
Patch by Cheryl Sabella.
2018-01-27 12:40:52 +10: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
İsmail Arılık
3764bb075a
Lexical Analysis ref doc: Fix a typo in the string concatenation internal link (GH-5157)
...
In lexical analysis reference documentation, the internal link to
the string literal concatenation section was written as`.. _string-catenation:`.
Changed that to `.. _string-concatenation:`.
2018-01-11 22:18:54 -08:00
KatherineMichel
f4e21a2a72
Improve the F-strings and format specifier documentation (GH-4931)
...
Mention that the format-specifier mini language in f-strings
is the same one used by str.format.
2017-12-19 13:03:09 -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
Mariatta
d924fa523d
F-strings docs: link to Format Specifiers (GH-4888)
...
Link to the Format Specification Mini Language section from f-strings' documentation.
2017-12-15 10:07:01 -08:00
Ivan Levkivskyi
5364b5cd75
bpo-32225: Implementation of PEP 562 ( #4731 )
...
Implement PEP 562: module __getattr__ and __dir__.
The implementation simply updates module_getattro and
module_dir.
2017-12-14 11:59:44 +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
Serhiy Storchaka
73a7e9b10b
bpo-10544: Deprecate "yield" in comprehensions and generator expressions. (GH-4579)
...
The current behaviour of yield expressions inside comprehensions and
generator expressions is essentially an accident of implementation - it
arises implicitly from the way the compiler handles yield expressions inside
nested functions and generators.
Since the current behaviour wasn't deliberately designed, and is inherently
confusing, we're deprecating it, with no current plans to reintroduce it.
Instead, our advice will be to use a named nested generator definition
for cases where this behaviour is desired.
2017-12-01 14:54:17 +10:00
Berker Peksag
7c9da3e5ba
Remove redundant 'exc = True' line (GH-4357)
...
It can be removed after c28890fb42
2017-11-11 17:55:05 +03:00
Tom Floyer
bf9d317626
bpo-31810: added missing keywords to docs. ( #4140 )
...
async and await keywords has been merged into upstream, but they are
all missing in the lexical analysis docs. This change adds them to the
appropriate keywords section in documentation.
2017-11-08 12:31:26 -05:00
Barry Warsaw
93952f8815
Fix a grammatical problem and reword for clarity. ( #4257 )
...
bpo-31936
2017-11-03 13:45:46 -07:00
Barry Warsaw
191e313820
bpo-31799: Make module.__spec__ more discoverable ( #4010 )
...
bpo-31799: Make module.__spec__ more discoverable
2017-10-17 15:52:38 -04:00
Yury Selivanov
b8ab9d3fc8
bpo-31708: Allow async generator expressions in synchronous functions ( #3905 )
2017-10-06 02:58:28 -04:00
Yury Selivanov
faa135acbf
bpo-31709: Drop support for asynchronous __aiter__. ( #3903 )
2017-10-06 02:08:57 -04:00
kms70847
8d59aca4a9
Fix typo in Simple Statements documentation (GH-3809)
...
Replace "restriction" with "restrictions".
2017-09-28 12:54:48 -07:00
Guilherme Caminha
4a2d00cb45
bpo-31571: Remove duplicated info in Lexical Analysis documentation (GH-3691)
...
- Remove the second mention about the `u` prefix
- Remove the second mention about numeric literals do not include a sign
2017-09-25 16:16:54 -07:00
svelankar
9b47af6537
bpo-31501: Operator precedence description for arithmetic operators ( #3633 )
2017-09-17 17:56:16 -07:00
Mariatta
63c591c0b0
bpo-31487: Update F-strings doc example (GH-3627)
...
Shorten the comment to: "using integer format specifier"
2017-09-17 07:43:31 -07:00
Mariatta
f361897069
Improve f-strings documentation (GH-3604)
...
Provide additional examples of using format specifiers in f-strings
Added examples for using integer and date format specifiers.
2017-09-16 11:46:43 -07:00
Louie Lu
b8d1b9d7c6
Mention enum as an ex ( #2982 )
2017-09-12 21:44:14 -07:00
Nick Coghlan
5a8516701f
bpo-31344: Per-frame control of trace events (GH-3417)
...
f_trace_lines: enable/disable line trace events
f_trace_opcodes: enable/disable opcode trace events
These are intended primarily for testing of the interpreter
itself, as they make it much easier to emulate signals
arriving at unfortunate times.
2017-09-08 10:14:16 +10:00
Benjamin Peterson
60dbed1850
link to legacy doc on the non-legacy website ( #3362 )
2017-09-05 16:24:39 -07:00
Benjamin Peterson
279a96206f
bpo-30736: upgrade to Unicode 10.0 ( #2344 )
...
Straightforward. While we're at it, though, strip trailing whitespace from generated tables.
2017-06-22 22:31:08 -07:00
Lisa Roach
64505a1f6c
bpo-30486: Allow setting cell value ( #1840 )
...
The cell_contents attribute of the cell object is now writable.
2017-06-08 14:43:26 +03:00
Mariatta
9efad1e5ae
bpo-17188: add missing periods at the end of sentences (GH-1875)
2017-05-30 15:26:42 -07:00
kms70847
9c972b5780
Improve grammar in The Import System documentation (GH-1862)
...
Replace `an ModuleNotFoundError` with `a ModuleNotFoundError`.
Replace `an path` with `a path`.
2017-05-30 09:12:33 -07:00
Aaron Hall, MBA
2b44e302ec
bpo-30449 Terse slots ( #1819 )
...
* correct __slots__ documentation with minimal changes
* add multiple inheritance info
* remove mapping from description
2017-05-25 22:33:26 -07:00
Naomi Ceder
43c8a9e39b
bpo-30372: Clarify that '__builtins__' is a CPython Implementation detail (GH-1725)
2017-05-22 14:09:55 -07:00
csabella
763557eac0
bpo-17188: DOC: Document 'from None' in raise statement ( #1671 )
...
Original patch by Dennis Mårtensson.
2017-05-20 02:48:28 -04:00
delirious-lettuce
3378b2062c
Fix typos in multiple `.rst` files ( #1668 )
2017-05-19 23:37:57 +03:00
Dominik Miedziński
af34e0a07b
Fix ModuleNotFoundError typo in import reference ( #1606 )
2017-05-16 19:40:17 +03:00
csabella
12b1c18098
bpo-30354: Update data model documentation for super() (GH-1561)
...
The data model section of the language reference was written well
before the zero-argument form of super() was added.
To avoid giving the impression that they're doing something
unusual, this updates the description of `__new__` and `__init__`
to use the zero-argument form.
Patch by Cheryl Sabella.
2017-05-15 13:42:00 +10:00
Serhiy Storchaka
7e19dbc92e
bpo-28974: `object.__format__(x, '')` is now equivalent to `str(x)` ( #506 )
...
rather than `format(str(self), '')`.
2017-05-13 12:40:52 +03:00
Jim Fasarakis-Hilliard
f34c685020
Fix a trivial typo in global section ( #1497 )
2017-05-08 04:36:29 -07:00
UltimateCoder
8856940cf2
bpo-28315: Improve code examples in docs (GH-1372)
...
Replace
File "<stdin>", line 1, in ?
with
File "<stdin>", line 1, in <module>
2017-05-03 09:46:45 -07:00
Jelle Zijlstra
2e624690bd
bpo-29679: Implement @contextlib.asynccontextmanager ( #360 )
2017-04-30 18:25:58 -07:00
csabella
c6db4811f9
bpo-30052: Link `bytes` & `bytearray` to stdtypes not functions (GH-1271)
...
Builtin container types have two potential link targets in the docs:
- their entry in the list of builtin callables
- their type documentation
This change brings `bytes` and `bytearray` into line with other
container types by having cross-references default to linking to
their type documentation, rather than their builtin callable entry.
2017-04-26 15:47:01 +10:00
Serhiy Storchaka
2e576f5aec
bpo-30144: Import collections ABC from collections.abc rather than collections. ( #1263 )
2017-04-24 09:05:00 +03:00
Serhiy Storchaka
85157cd89a
bpo-15718: Document the upper bound constrain on the __len__ return value. ( #1256 )
2017-04-23 08:37:58 +03:00
Serhiy Storchaka
997a4adea6
Remove outdated note about constraining of the bit shift right operand. ( #1258 )
...
The constrain was removed in bpo-29816.
2017-04-22 21:50:09 +03:00
cocoatomo
cdcac039fb
bpo-29952: Use usual terminology of dict (GH-917)
...
s/keys and elements/keys and values/
2017-03-31 14:48:49 +09:00
Amit Kumar
0ae7c8bd61
bpo-16011 clarify that 'in' always returns a boolean value
2017-03-28 10:13:01 -04:00
Ivan Levkivskyi
fad7f15606
Remove an outdated statement in execution model docs (GH-754)
2017-03-22 17:54:53 -07:00
Mariatta
d4e89287b3
bpo-28739: Document that f-strings cannot be used as docstring (GH-592)
2017-03-10 08:58:40 -08:00
Mariatta
1f5639c77f
bpo-26184: import.rst: Improve versionchanged note (GH-325)
2017-02-26 13:23:38 -08:00
Mariatta
6b4a5f45e2
bpo-26184: import.rst: Improve versionchanged note (GH-277)
...
Mention that an ImportError is raised when exec_module() is defined, but
create_module() is not.
2017-02-26 07:36:57 -08:00
Marco Buttu
46ce7599af
bpo-29648: import.rst: Add reference to create_module() (GH-290)
...
Add a reference to create_module(), in the first versionadded of section Loaders.
2017-02-26 07:14:45 -08:00
Jim Fasarakis-Hilliard
132ac381fe
Fix small typos in expressions.rst (GH-276)
2017-02-24 12:32:54 -08:00
Martin Panter
2be9889405
Issues #12067 : Merge hash recommendation from 3.5
2017-01-29 10:07:26 +00:00
Martin Panter
8dbb0ca573
Issue #12067 : Recommend that hash and equality be consistent
2017-01-29 10:00:23 +00:00
Berker Peksag
406c252970
Issue #29012 : Merge from 3.5
2017-01-03 03:35:49 +03:00
Berker Peksag
7b4e551091
Issue #29012 : Remove another outdated information
...
Patch by Jim Fasarakis-Hilliard.
2017-01-03 03:34:15 +03:00
Berker Peksag
a22457ecaf
Issue #29012 : Merge from 3.5
2017-01-02 06:01:07 +03:00
Berker Peksag
14adafd6ee
Issue #29012 : Remove outdated information about __bases__
...
Patch by Jim Fasarakis-Hilliard.
2017-01-02 06:00:35 +03:00
Martin Panter
7e930d7677
Issue #28954 : Merge keyword argument syntax from 3.5
2016-12-24 10:21:30 +00:00
Martin Panter
7106a51c71
Issue #28954 : Add missing comma to keyword argument syntax
2016-12-24 10:20:38 +00:00
Victor Stinner
01e4c1175f
Merge 3.5
2016-12-19 13:09:55 +01:00
Victor Stinner
509476b370
doc: Suggest to hash(tuple of attr) rather than XOR
...
Issue #28383 : __hash__ documentation recommends naive XOR to combine but this
is suboptimal. Update the doc to suggest to reuse the hash() method using a
tuple, with an example.
2016-12-19 13:09:28 +01:00
Yury Selivanov
03660041d2
Issue #28091 : Document PEP 525 & PEP 530.
...
Patch by Eric Appelt.
2016-12-15 17:36:05 -05:00
Nick Coghlan
19d246745d
Issue #23722 : improve __classcell__ compatibility
...
Handling zero-argument super() in __init_subclass__ and
__set_name__ involved moving __class__ initialisation to
type.__new__. This requires cooperation from custom
metaclasses to ensure that the new __classcell__ entry
is passed along appropriately.
The initial implementation of that change resulted in abruptly
broken zero-argument super() support in metaclasses that didn't
adhere to the new requirements (such as Django's metaclass for
Model definitions).
The updated approach adopted here instead emits a deprecation
warning for those cases, and makes them work the same way they
did in Python 3.5.
This patch also improves the related class machinery documentation
to cover these details and to include more reader-friendly
cross-references and index entries.
2016-12-05 16:47:55 +10:00
Martin Panter
28540183c9
Another en → em dash fix for 3.6
2016-11-21 04:10:45 +00:00
Jason R. Coombs
f66f03bd35
Update docs to reflect new behavior around backslashes in expressions (not allowed), matching recent changes to PEP 498.
2016-11-06 11:27:17 -05:00
Serhiy Storchaka
989db5c880
Issue #19795 : Mark up None as literal text.
2016-10-19 16:37:13 +03:00
Serhiy Storchaka
ecf41da83e
Issue #19795 : Mark up None as literal text.
2016-10-19 16:29:26 +03:00
Raymond Hettinger
0b51fd4341
merge
2016-09-11 17:24:05 -07:00
Raymond Hettinger
06e18a7c24
Issue #26511 : Reference the id() function in the 'is' and 'is not' docs
2016-09-11 17:23:49 -07:00
Guido van Rossum
015d874626
Issue #28076 : Variable annotations should be mangled for private names.
...
By Ivan Levkivskyi.
2016-09-11 09:45:24 -07:00
Brett Cannon
a721abac29
Issue #26331 : Implement the parsing part of PEP 515.
...
Thanks to Georg Brandl for the patch.
2016-09-09 14:57:09 -07:00
Eric Snow
68f4dd8b01
Doc updates for PEPs 520 and 468.
2016-09-09 11:22:14 -07:00
Guido van Rossum
6cff8744a0
Issue #27999 : Make "global after use" a SyntaxError, and ditto for nonlocal.
...
Patch by Ivan Levkivskyi.
2016-09-09 09:36:26 -07: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
Eric Snow
4f29e75289
Issue #24254 : Drop cls.__definition_order__.
2016-09-08 15:11:11 -07:00
Eric Snow
b957b0c2bc
Issue #28030 : Update the language reference for PEP 468.
2016-09-08 13:59:58 -07:00
R David Murray
110b6fecbb
#27364 : Deprecate invalid escape strings in str/byutes.
...
Patch by Emanuel Barry, reviewed by Serhiy Storchaka and Martin Panter.
2016-09-08 15:34:08 -04:00
Eric Snow
46f97b85a8
Issue #15767 : Use ModuleNotFoundError.
2016-09-07 16:56:15 -07:00
Eric Snow
92a6c170e6
Issue #24254 : Preserve class attribute definition order.
2016-09-05 14:50:11 -07:00
Raymond Hettinger
f74c33ad5c
Merge
2016-08-25 21:12:16 -07:00
Raymond Hettinger
7ea386e56e
Issue 19504: Change "customise" to "customize" American spelling.
2016-08-25 21:11:50 -07:00
Guido van Rossum
97c1adf393
Anti-registration of various ABC methods.
...
- Issue #25958 : Support "anti-registration" of special methods from
various ABCs, like __hash__, __iter__ or __len__. All these (and
several more) can be set to None in an implementation class and the
behavior will be as if the method is not defined at all.
(Previously, this mechanism existed only for __hash__, to make
mutable classes unhashable.) Code contributed by Andrew Barnert and
Ivan Levkivskyi.
2016-08-18 09:22:23 -07:00
Brett Cannon
3f63483a30
Merge for issue #27712
2016-08-12 10:57:17 -07:00
Brett Cannon
6336fb2734
Issue #27712 : Fix some typos in the import docs.
...
Thanks to Xiang Zhang for the patch.
2016-08-12 10:56:48 -07:00
Berker Peksag
91494d3b73
Issue #26576 : Merge from 3.5
2016-08-03 10:17:51 +03:00
Berker Peksag
6cafececbf
Issue #26576 : Clarify that the @deco syntax is not always an equivalent of f = deco(f)
...
Patch by Chris Angelico.
2016-08-03 10:17:21 +03:00
Nick Coghlan
607e1c4c44
Issue 27366: PEP 487 docs updates
...
- Porting note for type keyword arg handling
- __init_subclass__ note regarding metaclass hint
2016-07-31 12:42:49 +10:00
Berker Peksag
01d1719062
Issue #27366 : Tweak PEP 487 documentation
...
* Added versionadded directives
* Deleted duplicate sentence from __init_subclass__ docstring
* Modernized tests
2016-07-30 14:06:15 +03:00
Nick Coghlan
d78448e912
Issue #27366 : Implement PEP 487
...
- __init_subclass__ called when new subclasses defined
- __set_name__ called when descriptors are part of a
class definition
2016-07-30 16:26:03 +10:00
Martin Panter
6a09315ff0
Issue #26462 : Merge code block fixes from 3.5
2016-07-29 01:49:37 +00:00