Commit graph

7521 commits

Author SHA1 Message Date
Mariatta
21c697fd10 bpo-22594: Add a link to the regex module in re documentation (GH-241) (GH-317)
(cherry picked from commit ed6795e46f)
2017-02-26 07:44:36 -08:00
Barry Warsaw
66b5092fac bpo-25008: Deprecate smtpd and point to aiosmtpd (#274) (#279) 2017-02-24 16:15:17 -05:00
Arne de Laat
fa30453568 bpo-28911: Clarify the behaviour of assert_called_once_with. (#254)
(cherry picked from commit 9d56b34af2)
2017-02-23 17:16:56 +01:00
Berker Peksag
0246422b97 bpo-28814: Undeprecate inadvertently deprecated inspect functions. (#122) (#244)
Nick Coghlan said on bpo-28814:

> inspect.getargvalues() and inspect.formatargvalues() were deprecated
> in Python 3.5 as part of implementing bpo-20438

> This is incorrect, as these are *frame* introspection related functions,
> not callable introspection ones. The documentation and implementation
> layout is confusing though, as they're interleaved with the callable
> introspection operation

This commit undeprecates these functions and adds a note to ignore
previous deprecation notices.

(cherry picked from commit 0899b98095)
2017-02-24 01:45:57 +10:00
Berker Peksag
6336f0d156 bpo-29554: Improve docs for pstat module and profile. (#88) (#228)
Clarify that methods take a string which is interpreted as a regex,
not a regex object.

Also clarify what the old `-1`, `0`, `1` and `2` options were.

(cherry picked from commit 8fb1f6e039)
2017-02-22 04:55:03 +03:00
Mariatta
bb53a27a5d [cherry-pick for 3.5] bpo-29481: add versionadded 3.5.4 to typing.Deque docs (#109)
(cherry picked from commit 7e147f1ddb)
2017-02-15 11:39:37 -08:00
Mariatta
ae828714eb bpo-29474: Improve documentation for weakref.WeakValueDictionary (#23)
There were some grammatical errors in weakref.WeakValueDictionary
documentation.
2017-02-12 08:21:36 -08:00
Berker Peksag
f59286794b Issue #29441: Update examples to use async and await keywords in asyncio-task.rst 2017-02-07 11:27:09 +03:00
Mariatta Wijaya
81b8977349 Issue #29371: Clarify bitwise OR operation in doctest option flags. 2017-02-06 20:15:01 -08:00
Berker Peksag
5702fb7b4d Issue #29198: Fix indentation and markup in typing.rst
Patch by Jelle Zijlstra.
2017-02-04 09:34:16 +03:00
Berker Peksag
38962a6fe2 Issue #29198: Document typing.AsyncGenerator
Patch by Jelle Zijlstra.
2017-02-04 09:18:11 +03:00
Berker Peksag
d5adb63673 Issue #29407: Remove redundant ensure_future() calls in factorial example 2017-02-01 22:37:16 +03:00
Martin Panter
1f10671fc8 Issue #11670: readfp(fp) parameter name is different to read_file(f) 2017-01-29 23:33:27 +00:00
Martin Panter
ef107ee7a0 Issue #29189: Fix indentation in RST markup 2017-01-24 00:26:56 +00:00
Xiang Zhang
d7d87ca9b0 Issue #29092: Sync os.stat's doc and docstring on path type. 2017-01-22 12:54:44 +08:00
Martin Panter
37f183d43d Issue #29274: tests cases → test cases 2017-01-18 12:06:38 +00: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
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
Serhiy Storchaka
87006a3d4a Issue #20804: Document the limitation of the unittest.mock.sentinel attributes. 2017-01-11 20:16:44 +02:00
Xiang Zhang
8a17995589 Issue #29217: Fix the wrong type description of UUID.variant. 2017-01-10 11:29:27 +08: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
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
Xiang Zhang
cea904f286 Issue #29112: Fix a questionable wording in sequence doc. 2016-12-30 11:57:09 +08: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
Berker Peksag
8e2bdc8fe8 Move versionadded inside of the get_terminal_size() block 2016-12-27 15:09:11 +03: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
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
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
Martin Panter
2f9171d900 Fix spelling and grammar in code comments and documentation 2016-12-18 01:23:09 +00: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
Berker Peksag
7b440dfec4 Issue #28944: Fix footnote numbering 2016-12-15 05:37:56 +03: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
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
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
Martin Panter
6a4d7629da Fix indentation 2016-11-21 13:36:36 +00:00
Martin Panter
357ed2e577 Change double hyphens (en dashes) to em (longer) dashes 2016-11-21 00:15:20 +00:00
Martin Panter
efbf20f3a3 Issue #28678: Fix references to numeric_owner parameter 2016-11-13 23:25:06 +00:00
Serhiy Storchaka
022371ff94 Fixed the documentation of parse_constant argument in json.load().
parse_constant doesn't get called on 'null', 'true', 'false' since 3.1/2.7.
2016-11-12 22:47:16 +02:00
Guido van Rossum
ae08687c3b Issue 28644: Document recent changes in typing.py (Ivan L) 2016-11-11 15:54:04 -08:00
Andrew Kuchling
58c534dd6c Use http instead of https, due to certificate error 2016-11-08 22:33:31 -05:00
Andrew Kuchling
d58fc8b89e Update URL for requests documentation after IRC request 2016-11-08 22:07:43 -05:00
Yury Selivanov
3b3a141a83 Issue #27392: Document loop.connect_accepted_socket()
Patch by Jim Fulton.
2016-11-07 15:35:25 -05:00