Commit Graph

20251 Commits

Author SHA1 Message Date
Martin Panter ef107ee7a0 Issue #29189: Fix indentation in RST markup 2017-01-24 00:26:56 +00:00
Victor Stinner 01f5ae7b76 Issue #26273: Document TCP_USER_TIMEOUT and TCP_CONGESTION 2017-01-23 12:30:00 +01:00
Xiang Zhang 4459e009ed Issue #29092: Sync os.stat's doc and docstring on path type. 2017-01-22 13:04:17 +08:00
Xiang Zhang d7d87ca9b0 Issue #29092: Sync os.stat's doc and docstring on path type. 2017-01-22 12:54:44 +08:00
Ned Deily 67c1cb2008 Issue #29316: Restore the provisional status of typing module and add
corresponding note to documentation. Patch by Ivan L.
2017-01-20 10:13:23 -05:00
Raymond Hettinger a57a8a3e2d Issue #29281: Fill-in a missing versionchanged entry 2017-01-19 21:39:37 -08:00
Xiang Zhang 346454c7f5 Issue #29292: Merge 3.5. 2017-01-20 11:29:48 +08:00
Xiang Zhang 6ad85bf89a Issue #29292: Update outdated doc of PyEval_EvalCodeEx.
Patch by Ammar Askar.
2017-01-20 11:29:11 +08:00
Martin Panter 4710935b11 Issue 29274: Merge doc fixes from 3.5 2017-01-18 12:11:12 +00:00
Martin Panter 37f183d43d Issue #29274: tests cases → test cases 2017-01-18 12:06:38 +00:00
Raymond Hettinger e12c313f5e merge 2017-01-16 22:43:43 -08:00
Raymond Hettinger 80490525e0 Issue #29011: Fix an important omission by adding Deque to the typing module. 2017-01-16 22:42:37 -08:00
INADA Naoki 2e1b6ea4b7 Issue #29062: Doc: Fix make suspicious 2017-01-14 21:04:21 +09:00
Martin Panter 4659ddc433 Merge doc fixes from 3.5 2017-01-14 09:54:57 +00:00
Martin Panter 8f1378366e Avoid line breaks after hyphens, otherwise they are turned into spaces 2017-01-14 08:24:20 +00:00
Martin Panter 536d70ed33 Fix grammar, typos and markup in documentation and code comments
* Indent versionchanged at method level, not class level
* Mark up ``--help`` to avoid generating an en dash
* Use forward slash in Unix command line with a dollar sign ($) prompt
2017-01-14 08:23:08 +00:00
INADA Naoki e2f9e77df2 Issue #29062: Merge hashlib-blake2.rst into hashlib.rst 2017-01-13 19:29:58 +09:00
Serhiy Storchaka 3159b33a95 Merge with 3.5. 2017-01-11 20:17:34 +02:00
Serhiy Storchaka 87006a3d4a Issue #20804: Document the limitation of the unittest.mock.sentinel attributes. 2017-01-11 20:16:44 +02:00
Martin Panter ced4b90756 Issue #29239: Fix --enable-optimizations bug number 2017-01-11 11:56:22 +00:00
Martin Panter a27b3b3192 Issue #15657: Merge other doc fix from 3.5 2017-01-11 11:51:02 +00:00
Martin Panter 5b66723b0b Issue #15657: Delete incorrect statement from PyMethodDef documentation
Patch by Berker Peksag.
2017-01-11 11:50:06 +00:00
Martin Panter 9da31f7274 Issue #15657: METH_KEYWORDS cannot be used alone in Python 3 2017-01-11 11:41:03 +00:00
Xiang Zhang 2427d00298 Issue #29217: Merge 3.5. 2017-01-10 11:30:02 +08:00
Xiang Zhang 8a17995589 Issue #29217: Fix the wrong type description of UUID.variant. 2017-01-10 11:29:27 +08:00
Vinay Sajip aa655b3a8e Fixes #29133: clarified shlex documentation. 2017-01-09 16:46:04 +00:00
Raymond Hettinger d15bb26248 Update OrderedDict docs to reflect acceptance of PEP 468 2017-01-07 22:05:12 -08:00
Berker Peksag 631ada8424 Issue #16026: Fix parameter names of DictReader and DictWriter
CPython and PyPy use f as the name of the first parameter of
DictReader and DictWriter classes.

Patch by James Salt and Greg Bengeult.
2017-01-07 09:32:56 +03: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
Benjamin Peterson 5848e72ee1 merge 3.5 2017-01-01 22:08:44 -06:00
Benjamin Peterson 4365833d11 merge 3.4 2017-01-01 22:08:33 -06:00
Benjamin Peterson b6e2142b0c merge 3.3 2017-01-01 22:07:37 -06:00
Benjamin Peterson e527dd34bc ring in 2017 for Python 2017-01-01 22:04:13 -06:00
Berker Peksag 5430293fdf Issue #29013: Merge from 3.5 2017-01-02 06:14:12 +03:00
Berker Peksag 4950ae1491 Issue #29013: Fix allowZip64 documentation
Zip files can be larger than 4 GiB if allowZip64
is true (default since Python 3.4)
2017-01-02 06:13:42 +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
Berker Peksag 2a267a12ee Issue #29129: Fix typo in "Using auto" section 2017-01-02 05:51:04 +03:00
Berker Peksag 37023b64d7 Issue #29024: Merge from 3.5 2017-01-02 05:45:16 +03:00
Berker Peksag d2d673fc4c Issue #29024: Add Kivy entry to GUI FAQ
Patch by inclement.
2017-01-02 05:44:49 +03:00
Berker Peksag 9db22dd968 Issue #26267: Merge from 3.5 2016-12-31 20:08:53 +03:00
Berker Peksag 6b5e4a86a7 Issue #26267: Improve uuid.UUID documentation
* Document how comparison of UUID objects work
* Document str(uuid) returns the braceless standard form
* Add a test for comparison of a UUID object with a non-UUID object

Patch by Ammar Askar.
2016-12-31 20:08:16 +03:00
Vinay Sajip 53a21eb479 Closes #29105: Updated RotatingFileHandler documentation. 2016-12-31 11:06:57 +00:00
Raymond Hettinger 51447db47c Clearer compact dict attribution to the original proposal 2016-12-29 23:49:20 -07:00
Xiang Zhang 9ea82ddad5 Issue #29112: Merge 3.5. 2016-12-30 11:57:40 +08:00
Xiang Zhang cea904f286 Issue #29112: Fix a questionable wording in sequence doc. 2016-12-30 11:57:09 +08:00
Victor Stinner 771cf898f4 Merge 3.5 2016-12-30 02:15:29 +01:00
Victor Stinner 440d70301b Issue #29109: Enhance tracemalloc documentation
* Wrong parameter name, 'group_by' instead of 'key_type'
* Don't round up numbers when explaining the examples. If they exactly match
  what can be read in the script output, it is to easier to understand
  (4.8 MiB vs 4855 KiB)
* Fix incorrect method link that was pointing to another module

Patch written by Loic Pefferkorn.
2016-12-30 02:14:59 +01:00
Serhiy Storchaka 44223e9550 Issue #29087: Removed the documentation of non-existing UCS4 support functions. 2016-12-28 09:19:45 +02:00
Serhiy Storchaka af9181a4f2 Issue #29087: Removed the documentation of non-existing UCS4 support functions. 2016-12-28 09:19:15 +02:00
Berker Peksag 5d1111e87e Issue #29069: Merge from 3.5 2016-12-27 15:16:55 +03:00
Berker Peksag 1fee5151f7 Issue #29069: Update the default URL of PyPI server
Patch by paka.
2016-12-27 15:16:25 +03:00
Berker Peksag fe607beef7 Merge from 3.5 2016-12-27 15:09:35 +03:00
Berker Peksag 8e2bdc8fe8 Move versionadded inside of the get_terminal_size() block 2016-12-27 15:09:11 +03:00
Xiang Zhang b8a1aebb3d Issue #29078: Merge 3.5. 2016-12-27 12:30:42 +08:00
Xiang Zhang 6721c7c3b2 Issue #29078: Add the missing import in datetime.time doc example.
Patch by Dhushyanth Ramasamy.
2016-12-27 12:23:59 +08:00
Serhiy Storchaka a8803d21e7 Merge from 3.5. 2016-12-25 16:23:42 +02:00
Serhiy Storchaka 4398c12b47 Issue #29068: Fixed a typo in PyErr_Fetch example.
Patch by Chi Hsuan Yen.
2016-12-25 16:22:23 +02: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
Martin Panter 0efb5b3538 Issue #1446619: Merge slicing description from 3.5 2016-12-24 08:31:11 +00:00
Martin Panter 3dbd87f2b9 Issue #1446619: Account for negative slice direction in description
Based on suggestion from Fumihiro Bessho.
2016-12-24 08:25:15 +00:00
Martin Panter 520569e9bd Issue #29004: Merge crc_hqx() doc from 3.5 2016-12-24 07:44:03 +00:00
Martin Panter 3a72ee5b5a Issue #28960: Merge Thread.join() doc from 3.5 2016-12-24 07:40:09 +00:00
Martin Panter 3310e146cc Issue #29004: Document binascii.crc_hqx() implements CRC-CCITT 2016-12-24 07:36:44 +00:00
Martin Panter 972e04ec46 Issue #28960: Drop comma attached to dash in Thread.join() description 2016-12-24 07:28:26 +00:00
Ned Deily e31b15c4ce Update documentation index sidebar for 3.6.0 release. 2016-12-23 04:13:31 -05:00
Ned Deily 93357d8d43 Merge 3.6.0 release engineering head 2016-12-22 19:50:19 -05:00
Ned Deily 5c4568a05a Update docs and patchlevel for 3.6.0 final. 2016-12-22 18:38:47 -05:00
Brett Cannon 73224c4248 Merge 2016-12-22 10:02:16 -08:00
Brett Cannon 7e93c84438 Grammatical fixes following #d95f19892fd0 2016-12-22 10:02:01 -08: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
Xiang Zhang 47888da90b Issue #29009: Merge 3.5. 2016-12-19 18:39:02 +08:00
Xiang Zhang bfbc29cb8f Issue #29009: Remove outdated doc of PyUnicode_RichCompare. 2016-12-19 18:35:14 +08:00
R David Murray cd259bfd5a Merge: #29005: clarify terminology in tutorial 'method' discussion. 2016-12-18 15:00:23 -05:00
R David Murray 4ec1590fbf #29005: clarify terminology in tutorial 'method' discussion.
Patch by Jim Fasarakis-Hilliard.
2016-12-18 14:59:58 -05:00
Martin Panter 59b0eb524f Issue #28987: Typos, grammar, spelling in documentation 2016-12-18 01:26:53 +00:00
Martin Panter fff07e34fa Merge spelling and grammar from 3.5 2016-12-18 05:37:21 +00:00
Martin Panter 2f9171d900 Fix spelling and grammar in code comments and documentation 2016-12-18 01:23:09 +00:00
Brett Cannon ce042af3fe Merge for porting HOWTO update 2016-12-17 12:37:41 -08:00
Brett Cannon 5866719510 Update porting HOWTO to drop unicode_literals and mention static type checking 2016-12-17 12:37:20 -08:00
Serhiy Storchaka 9bb6fe5274 Issue #14061: Misc fixes and cleanups in archiving code in shutil.
Imporoved the documentation and tests for make_archive() and unpack_archive().
Improved error handling when corresponding compress module is not available.
Brake circular dependency between shutil and tarfile modules.
2016-12-16 19:00:55 +02:00
Serhiy Storchaka 20cdffd830 Issue #14061: Misc fixes and cleanups in archiving code in shutil.
Imporoved the documentation and tests for make_archive() and unpack_archive().
Improved error handling when corresponding compress module is not available.
Brake circular dependency between shutil and tarfile modules.
2016-12-16 18:58:33 +02:00
Yury Selivanov 6db7a4b81a docs: asyncio is no longer provisional 2016-12-15 18:58:19 -05:00
Yury Selivanov 1217470984 Issue #28635: asyncio-related fixes and additions. 2016-12-15 17:56:43 -05:00
Yury Selivanov 03660041d2 Issue #28091: Document PEP 525 & PEP 530.
Patch by Eric Appelt.
2016-12-15 17:36:05 -05:00
Victor Stinner 8320193d10 Issue #28979: Fix What's New in Python 3.6, dict
The new dict implementation is not faster, but more compact.

Patch written by Brendan Donegan.
2016-12-15 16:20:53 +01:00
Berker Peksag 0bf590627b Issue #28944: Merge from 3.5 2016-12-15 05:38:25 +03:00
Berker Peksag 7b440dfec4 Issue #28944: Fix footnote numbering 2016-12-15 05:37:56 +03:00
Yury Selivanov 3432f2f47c Issue #28089: Document TCP_NODELAY in asyncio
Initial patch by Mariatta Wijaya.
2016-12-12 16:44:58 -05:00
Martin Panter 0a7b8596c0 Issues #28916, #26483: Merge stdtypes.rst from 3.5 2016-12-11 02:31:32 +00:00
Martin Panter 49c14d8e8f Issue #26483: Clarify str.isdecimal() and isdigit()
Patch by Julien Palard.
2016-12-11 01:08:25 +00:00
Martin Panter 41176ae1d2 Issue #28916: Correct description of %o and %x alternative forms
* In Python 3, the specifier is 0o
* There is no special case for leading zeros
* Remove duplicate tests
* Clarify other existing tests and comments
2016-12-11 01:07:29 +00:00
Brett Cannon 071fbcb63b Merge for issue #28424 2016-12-10 14:14:47 -08:00
Brett Cannon bc538e3852 Issue #28424: Document pkgutil.get_data() doesn't work with namespace packages.
Thanks to Douglas Greiman for the patch.
2016-12-10 14:13:38 -08:00
Martin Panter 21799618ec Issue #28771: Merge C API doc fix from 3.5 2016-12-10 05:57:38 +00:00
Martin Panter 7a44783b42 Issue #28771: Update tp_get/setattr signature documentation 2016-12-10 05:56:13 +00:00
Martin Panter 186b204997 Fix typos in comment and documentation 2016-12-10 05:32:55 +00:00
Martin Panter b7880b067b Issue #28820: Merge spelling fixes from 3.5 2016-12-10 05:38:25 +00:00
Martin Panter 898573a734 Issue #28820: Fix spelling of “practice” as a noun 2016-12-10 05:12:56 +00:00
Martin Panter 2fed8cd6f0 Issues #28755, #28753: Merge Arg Clinic howto from 3.5 2016-12-10 04:14:02 +00:00
Martin Panter cfa9bad4b2 Issue #28755: Improve syntax highlighting in Arg Clinic howto 2016-12-10 04:10:45 +00:00
Martin Panter a277c130f7 Issue 28753: Argument Clinic howto docfix, courtesy Julien Palard. 2016-12-10 03:49:12 +00:00
Ned Deily 932d40abf7 Issue #28900: Update documentation sidebar for 3.6.0rc. 2016-12-07 23:34:49 -05:00
Steve Dower 20367420c8 Issue #28896: Deprecate WindowsRegistryFinder 2016-12-07 13:02:27 -08:00
Serhiy Storchaka 419967b832 Issue #28808: PyUnicode_CompareWithASCIIString() now never raises exceptions. 2016-12-06 00:13:34 +02:00
Serhiy Storchaka 7bc01c32b1 Fixed mismatching title overline. 2016-12-04 15:42:13 +02:00
Serhiy Storchaka 29b0a26822 Fixed double hyphens that are rendered to literal en-dashes in the documenation. 2016-12-04 10:20:55 +02:00
Serhiy Storchaka ee1b01a41b Issue #21818: Fixed references to classes that have names matching with module
names.
2016-12-02 23:13:53 +02:00
Serhiy Storchaka c7b1a0bbe2 Issue #28763: Use double hyphens (rendered as en-dashes) in numerical ranges
in the documentation.
2016-11-26 13:43:28 +02:00
Berker Peksag 4931122de8 Add missing square bracket in typing.get_type_hints() 2016-11-25 20:10:07 +03:00
Berker Peksag 219a012156 Issue #28738: Document SIGBREAK as an acceptable value on Windows
Patch by Wojtek Ruszczewski.
2016-11-25 19:46:57 +03:00
Guido van Rossum a860286eab Issue #28773: Add typing.FrozenSet docs. (Manuel Krebber) 2016-11-24 11:56:00 -08:00
Yury Selivanov 8e1baa7583 docs: asyncio is no longer provisional
(grafted from 4cb3ea76ce68efd52271e499647abbf0f8a2941f)
2016-12-15 18:58:19 -05:00
Yury Selivanov 6e31235902 Issue #28635: asyncio-related fixes and additions.
(grafted from 418ba3a0f090ac0e17a935b7cd5a63ea8263a914)
2016-12-15 17:56:43 -05:00
Yury Selivanov 4f9e4285d2 Issue #28091: Document PEP 525 & PEP 530.
Patch by Eric Appelt.
(grafted from 78c8f450b84ca1864123ec487d363eb151f61a4a)
2016-12-15 17:36:05 -05:00
Victor Stinner 5e65a5f4ef Issue #28979: Fix What's New in Python 3.6, dict
The new dict implementation is not faster, but more compact.

Patch written by Brendan Donegan.
(grafted from 181453f9a0c424212f0f6ddca2b9065c15689d7c)
2016-12-15 16:20:53 +01:00
Yury Selivanov 291b93bb1f Issue #28089: Document TCP_NODELAY in asyncio
Initial patch by Mariatta Wijaya.
(grafted from 853e3f4d6cd98ac4590238bc1c60e40fd8ed3895)
2016-12-12 16:44:58 -05:00
Steve Dower 5dc1fb3eda Issue #28896: Deprecate WindowsRegistryFinder
(grafted from 25df9671663b5f8b1560d58d8842f9676f6dffc2)
2016-12-07 13:02:27 -08:00
Ned Deily 446e606bfe Issue #28900: Update documentation sidebar for 3.6.0rc. 2016-12-07 23:37:12 -05:00
Yury Selivanov 267862f9ca Issue #28635: Drop the note that whatsnew is incomplete
(grafted from d12bc674b74eee73365e38fad1f170ed3349bd59)
2016-12-07 16:19:56 -08:00
Serhiy Storchaka 53c53ea4c5 Issue #27030: Unknown escapes in re.sub() replacement template are allowed
again.  But they still are deprecated and will be disabled in 3.7.
2016-12-06 19:15:29 +02:00
Serhiy Storchaka 9a953dbb34 Issue #28808: PyUnicode_CompareWithASCIIString() now never raises exceptions. 2016-12-06 00:17:45 +02: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
Raymond Hettinger 71c62e14aa Neaten-up and extend the examples in the random module docs. 2016-12-04 11:00:34 -08:00
Serhiy Storchaka 223813111e Fixed mismatching title overline. 2016-12-04 15:43:37 +02:00
Serhiy Storchaka e418432dfb Fixed double hyphens that are rendered to literal en-dashes in the documenation. 2016-12-04 10:22:09 +02:00
Serhiy Storchaka b6a6b45458 Issue #21818: Fixed references to classes that have names matching with module
names.
2016-12-02 23:15:22 +02:00
Nick Coghlan 3c35fdb8fb Issue #27172: Undeprecate inspect.getfullargspec()
This is still useful for single source Python 2/3 code
migrating away from inspect.getargspec(), but that wasn't
clear with the documented deprecation in place.
2016-12-02 20:29:57 +10:00
Yury Selivanov 27ec5bfdcb Issue #28635: Document Python 3.6 opcode changes
Thanks to Serhiy Storchaka for pointing out the missing notes.

Patch by Elvis Pranskevichus.
2016-11-28 11:45:36 -05:00
Zachary Ware 0425fc0fad Fix grammar in whatsnew 2016-11-28 00:19:07 -06:00
Serhiy Storchaka 0264e46caa Issue #28763: Use double hyphens (rendered as en-dashes) in numerical ranges
in the documentation.
2016-11-26 13:49:59 +02:00
Berker Peksag 861b685941 Merge from 3.5 2016-11-25 20:10:30 +03:00
Berker Peksag d5c6b47851 Issue #28738: Merge from 3.6 2016-11-25 19:47:43 +03:00
Berker Peksag 61d9c8639e Issue #28793: Fix c/p error in AsyncGenerator documentation
Patch by Julien Palard.
2016-11-25 17:31:27 +03:00
Guido van Rossum b3c5dc912d Issue #28773: Add typing.FrozenSet docs. (Manuel Krebber) (3.5->3.6) 2016-11-24 11:56:40 -08:00
INADA Naoki f576343179 Issue #28532: Add what's new entry for python -VV option 2016-11-24 17:20:40 +09:00
Ned Deily 098f85bb7d Issue #28900: Update documentation sidebar for 3.6.0rc. 2016-12-07 23:37:12 -05:00
Yury Selivanov eb58936b64 Issue #28635: Drop the note that whatsnew is incomplete 2016-12-07 16:19:56 -08:00
Raymond Hettinger 6da9078195 Issue #27825: Improve for statistics data arguments. (Contributed by Mariatta Wijaya.) 2016-11-21 16:31:02 -08:00
Raymond Hettinger 8c5e190d36 Issue #28587: Improve list examples in the tutorial 2016-11-21 16:29:50 -08:00
Raymond Hettinger 7f94619555 Fix grammar 2016-11-21 15:13:18 -08:00
Raymond Hettinger 5bd5b9d813 Issue 28587: list.index documentation missing start and stop arguments. (Contributed by Mariatta Wijaya.) 2016-11-21 15:12:54 -08:00
Raymond Hettinger 1149d9326e Add analysis section to motivate the single server queue example 2016-11-21 14:13:07 -08:00
Raymond Hettinger e1329105b3 Misc readability and organization improvements for the random docs 2016-11-21 12:33:50 -08:00
Raymond Hettinger 0537405ec1 Add a seealso section for further reference and skill building 2016-11-21 10:52:04 -08:00
Raymond Hettinger 8ab1258b58 Simplify code in an example 2016-11-21 10:16:01 -08:00
Ethan Furman 23bb6f48ea close issue28172: Change all example enum member names to uppercase, per Guido; patch by Chris Angelico. 2016-11-21 09:22:05 -08:00