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
03660041d2
Issue #28091 : Document PEP 525 & PEP 530.
...
Patch by Eric Appelt.
2016-12-15 17:36:05 -05:00
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
28540183c9
Another en → em dash fix for 3.6
2016-11-21 04:10:45 +00:00
989db5c880
Issue #19795 : Mark up None as literal text.
2016-10-19 16:37:13 +03:00
ecf41da83e
Issue #19795 : Mark up None as literal text.
2016-10-19 16:29:26 +03:00
68f4dd8b01
Doc updates for PEPs 520 and 468.
2016-09-09 11:22:14 -07:00
f8cb8a16a3
Issue #27985 : Implement PEP 526 -- Syntax for Variable Annotations.
...
Patch by Ivan Levkivskyi.
2016-09-08 20:50:03 -07:00
4f29e75289
Issue #24254 : Drop cls.__definition_order__.
2016-09-08 15:11:11 -07:00
92a6c170e6
Issue #24254 : Preserve class attribute definition order.
2016-09-05 14:50:11 -07:00
f74c33ad5c
Merge
2016-08-25 21:12:16 -07:00
7ea386e56e
Issue 19504: Change "customise" to "customize" American spelling.
2016-08-25 21:11:50 -07:00
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
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
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
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
2fec611a70
Issue #24314 : Merge doc links from 3.5
2016-06-18 08:20:22 +00:00
bae5d81f5d
Issue #24314 : Fix doc links for general attributes like __name__, __dict__
2016-06-18 03:57:31 +00:00
5848ac2df0
Issue #15476 : Merge index entries from 3.5
2016-06-09 23:36:40 +00:00
711d25db48
Merge 3.5 (issue #27243 )
2016-06-09 15:13:16 -04:00
a6f6edbda8
Issue #27243 : Fix __aiter__ protocol
2016-06-09 15:08:31 -04:00
3bad04ca62
Merge: #26829 : Clarify that namespace is copied to a new __dict__ in instance creation.
2016-06-02 20:06:13 -04:00
dd4fcf52f4
#26829 : Clarify that namespace is copied to a new __dict__ in instance creation.
...
Patch by Emily Morehouse.
2016-06-02 20:05:43 -04:00
e9b8403a1f
[Issue 15476] Make "code object" its own entry in the index
2016-06-02 19:26:51 -04:00
c499f30286
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 12:01:56 +03:00
dba903993a
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
7b1e5a7722
Remove redundant leading zeroes in PEP references.
2016-03-31 15:31:20 +03:00
e4ba872543
Remove redundant leading zeroes in PEP references.
2016-03-31 15:30:54 +03:00
3e48b38dff
Merge 3.5 (issue #25887 )
2016-02-13 18:00:31 -05:00
77c96813ab
Issue #25887 : Raise a RuntimeError when a coroutine is awaited more than once.
2016-02-13 17:59:05 -05:00
bc1ee460dc
Issue #25179 : Documentation for formatted string literals aka f-strings
...
Some of the inspiration and wording is taken from the text of PEP 498 by Eric
V. Smith, and the existing str.format() documentation.
2016-02-13 00:41:37 +00:00
d2ad5718ad
Issue #25523 : Further a-to-an corrections new in 3.5
2015-11-02 04:20:33 +00:00
85d5d902ce
Issue #25418 : Fix markup in object.__hash__ documentation
...
Patch by TAKASE Arihiro.
2015-10-16 11:23:11 +03:00
edb9111d41
Issue #25418 : Fix markup in object.__hash__ documentation
...
Patch by TAKASE Arihiro.
2015-10-16 11:22:50 +03:00
84835ab1cb
Issue #25161 : Merge full stops from 3.4 into 3.5
2015-10-10 10:44:25 +00:00
d21e0b52f1
Issue #25161 : Add full stops in documentation; patch by Takase Arihiro
2015-10-10 10:36:22 +00:00
d84b29f805
Issue #4395 : Better testing and documentation of binary operators.
...
Patch by Martin Panter.
2015-08-07 10:22:54 +12:00
00cf3c394a
Issue #4395 : Better testing and documentation of binary operators.
...
Patch by Martin Panter.
2015-08-07 10:32:15 +12:00
66f8828bfc
Issue #24439 : Improve PEP 492 related docs.
...
Patch by Martin Panter.
2015-06-24 11:04:15 -04:00
f3e40fac10
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
770319d6bd
Issue #23912 : Fix code formatting in datamodel.rst.
...
Patch by James Edwards.
2015-04-11 14:59:30 +03:00
2995cc6855
Issue #23912 : Fix code formatting in datamodel.rst.
...
Patch by James Edwards.
2015-04-11 14:59:50 +03:00
9fdb0fe17b
Issue20467: clarify __init__'s role
2015-01-14 21:57:15 -08:00
845d33c526
Issue20467: clarify __init__'s role
2015-01-14 21:56:49 -08:00
119479f705
Issue20467: clarify __init__'s role
2015-01-14 21:56:10 -08:00
b67f6e27e1
Issue #23006 : Improve the documentation and indexing of dict.__missing__.
...
Add an entry in the language datamodel special methods section.
Revise and index its discussion in the stdtypes mapping/dict section.
2014-12-10 18:38:19 -05:00
c9f5f2ddc7
#22918 : Drop obsolete mention of 'keys' in datamodel __iter__ docs.
...
Patch by Chaitanya Agrawal.
2014-12-10 09:51:01 -05:00
b004943e9b
(3.4) Issue22780: reword NotImplemented docs to emphasise should
2014-11-26 21:15:35 -08:00
e6b2b78a7d
Merge 3.4
2014-12-10 18:39:45 -05:00
892dbd18e1
Merge: #22918 : Drop obsolete mention of 'keys' in datamodel __iter__ docs.
2014-12-10 09:51:27 -05:00
9b55089999
Issue22780: reword NotImplemented docs to emphasise should
2014-11-26 21:17:53 -08:00
e21a531ef1
merge with 3.4
2014-10-31 10:39:29 +01:00
a4c8c47961
#22613 : remaining corrections in extending/reference docs (thanks Jacques Ducasse)
2014-10-31 10:38:49 +01:00
cadc3fdcb5
Merge with 3.4
2014-10-29 08:37:29 +01:00
e73778c1ac
Use https:// URLs when referring to python.org hosts.
2014-10-29 08:36:35 +01:00
58b2ddf392
Issue7186: document that __doc__ is not inherited by subclasses
2014-10-17 22:25:47 -07:00
f87f515057
Issue7186: document that __doc__ is not inherited by subclasses
2014-10-17 22:25:22 -07:00
cd09571894
Merge with 3.4
2014-09-30 19:08:02 -04:00
b6271f2d2b
Issue 22465: grammar, number agreement.
2014-09-30 19:07:49 -04:00
e2197a4805
Merge issue #21667 from 3.4
2014-06-07 23:22:06 +10:00
1462786f00
Issue #21667 : Clarify string data model description
2014-06-07 23:21:14 +10:00
cc568b1222
Merge #21662 : fix typo, improve sentence flow
2014-06-05 15:32:34 -04:00
2c0781853a
#21662 : fix typo, improve sentence flow
...
Patch by Steve Dougherty.
2014-06-05 15:31:56 -04:00
a73a34d176
merge
2014-05-26 22:21:11 -07:00
aa7886dd3f
Issue 21439: Minor issues in the reference manual.
...
(Contributed by Feliks Kluzniak.)
2014-05-26 22:20:37 -07:00
384a3ea5c5
merge 3.4
2014-05-11 11:19:17 -07:00
5c8ce188ee
remove confusing delete indexing ( closes #21466 )
2014-05-11 11:18:51 -07:00
d51374ed78
PEP 465: a dedicated infix operator for matrix multiplication ( closes #21176 )
2014-04-09 23:55:56 -04:00
490a72e022
docs: Better wording for __objclass__ docs. Issue #19281
2014-04-08 14:01:12 -04:00
b9aa8cb0c7
docs: Document __objclass__. Closes #19281 .
...
Initial patch by Nick Coghlan
2014-04-08 12:04:04 -04:00
af8a4dfb04
docs: Better wording for __objclass__ docs. Issue #19281
2014-04-08 14:00:35 -04:00
d3f918ca44
docs: Document __objclass__. Closes #19281 .
...
Initial patch by Nick Coghlan
2014-04-08 12:03:07 -04:00
3732ed2414
Merge in all documentation changes since branching 3.4.0rc1.
2014-03-15 21:13:56 -07:00
6ae5eef542
Merge #19953 : Clarify the wording of the augmented assignment discussion.
2014-03-09 18:51:35 -04:00
14d7b718ba
#19953 : Clarify the wording of the augmented assignment discussion.
...
Patch by Priya Pappachan, based on suggestions from Terry Reedy
and myself.
2014-03-09 18:51:16 -04:00
af7d2c4917
whatsnew: LOAD_CLASSDEREF, -X showrefcount
2014-02-12 13:00:36 -05:00
d630e79cc7
whatsnew: object.__format__ raises TypeError on non-empty string.
...
See issues #7994 and #9856 . I also modified with wording of the format doc
entry to better match what really happens, and added a versionchanged to the
datamodel object.__format__ section.
2014-02-11 18:34:22 -05:00
df3ed242c0
Issue19995: %o, %x, %X now only accept ints
2014-01-05 06:50:30 -08:00
002033ed63
correct word for __annotations__ doc ( closes #20110 )
...
Patch from Claudiu Popa.
2014-01-02 16:47:50 -06:00
8ec15f7a92
merge 3.3 ( #20110 )
2014-01-02 16:48:24 -06:00
1cb4f607d1
Merge with 3.3
2013-12-31 12:10:24 -06:00
340a692283
str subclasses may have non-empty __slots__, bytes subclasses can't.
2013-12-31 12:09:26 -06:00
0e90e99188
Issue #19795 : Improved markup of True/False constants.
2013-11-29 12:19:53 +02:00
fbc1c26803
Issue #19795 : Improved markup of True/False constants.
2013-11-29 12:17:13 +02:00
0d85b5c68d
Issue #19190 : Improve cross-references in builtin types and functions documentation.
2013-10-09 14:03:24 +03:00
0d196edc37
Issue #19190 : Improve cross-references in builtin types and functions documentation.
2013-10-09 14:02:31 +03:00
58720d6145
Issue #17934 : Add a clear() method to frame objects, to help clean up expensive details (local variables) and break reference cycles.
2013-08-05 23:26:40 +02:00
796564c27b
Issue #18112 : PEP 442 implementation (safe object finalization).
2013-07-30 19:59:21 +02:00
4958f714bd
- Issue #18440 : Clarify that `hash()` can truncate the value returned from an
...
object's custom `__hash__()` method.
2013-07-15 15:21:41 -04:00
224a599c0c
- Issue #18440 : Clarify that `hash()` can truncate the value returned from an
...
object's custom `__hash__()` method.
2013-07-15 14:47:29 -04:00
1bab7134a8
Merge with 3.3.
2013-03-28 13:28:55 +01:00
44ea77bd81
Closes #4159 : add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text.
2013-03-28 13:28:44 +01:00
16459e8b16
Merge from 3.3: Add a str class entry to the string section (issue #16209 ).
...
This commit also moves the documentation for the str built-in function to
the new class entry. Links to :class:`str` now go to the class entry with
the string methods immediately afterwards.
2012-11-28 01:45:15 -08:00
bb4e941c6d
Add a str class entry to the "Text Sequence Type" section (issue #16209 ).
...
This commit also moves the documentation for the str built-in function to
the new class entry. Links to :class:`str` now go to the class entry with
the string methods immediately afterwards.
2012-11-28 01:38:40 -08:00
d675a2c48a
Merge from 3.3: Improve str() and object.__str__() docs (issue #13538 ).
2012-11-20 17:53:17 -08:00
5fae0e5854
Improve str() and object.__str__() documentation (issue #13538 ).
2012-11-20 17:45:51 -08:00
143d034ecd
merge 3.2
2012-10-12 12:04:32 -04:00
5c3283e43a
Merge __next__ method link fixes with 3.3.
2012-10-12 13:46:37 +03:00
1dd7c30419
Merge __next__ method link fixes with 3.2.
2012-10-12 13:45:38 +03:00
7fa822275b
Fix links to the __next__ method.
2012-10-12 13:42:08 +03:00
Victor Stinner
Yury Selivanov
Nick Coghlan
Martin Panter
Serhiy Storchaka
Eric Snow
Raymond Hettinger
Guido van Rossum
Berker Peksag
R David Murray
Tommy Beadle
Yury Selivanov
Robert Collins
Ethan Furman
Terry Jan Reedy
Georg Brandl
Benjamin Peterson
Larry Hastings
Zachary Ware
Antoine Pitrou
Barry Warsaw
Chris Jerdonek
Ezio Melotti