Commit graph

18402 commits

Author SHA1 Message Date
Brett Cannon
762d5ea875 Issue #12484: Remove a mention of Py_InitModule() and _PyImport_FixupExtension().
Thanks to Alejandro Santos for the bug report and Anish Shah for the
patch.
2015-12-27 12:24:06 -08:00
Brett Cannon
85622e4bc9 Issue #25874: Clarify platform support in the "Using Python on Windows" doc.
Thanks to Chris Wilcox for the initial patch.
2015-12-27 12:08:37 -08:00
R David Murray
a198645fa0 #1753718: clarify RFC compliance and bytes/string argument types.
Patch includes contributions by Isobel Hooper, incorporating suggestions from
Paul Winkler.  Reviewed by Martin Panter.

In addition to accepting the corrections for the RFC compliance wording, I
went through and corrected all the argument and return types, and made the
pattern of how the arguments and return types are documented consistent.
So, this patch also addresses #20782, though I had forgotten about that issue
and its patch.
2015-12-23 21:17:17 -05:00
Yury Selivanov
3dc74bf703 docs: Document ASYNC/AWAIT tokens (issue #25580)
Initial patch by SilentGhost
2015-12-17 18:26:41 -05:00
Yury Selivanov
9920e293c3 Merge 3.4 2015-12-16 21:31:04 -05:00
Yury Selivanov
cba0053bef docs/asyncio: Twek sections names per Nick Coghlan suggestion 2015-12-16 21:30:52 -05:00
Yury Selivanov
e319ab01ce docs/asyncio: Update ensure_future & run_coroutine_threadsafe docs 2015-12-15 00:45:24 -05:00
Yury Selivanov
4a18b35dbd docs/whatsnew/3.5: Fix ref link 2015-12-15 00:38:28 -05:00
Yury Selivanov
bf077ee043 whatsnew/3.5: Mention new asyncio APIs in 3.5.1 2015-12-15 00:30:18 -05:00
Gregory P. Smith
f1b3134d28 Issue #11072: change the incorrect "deprecation" of ftplib dir() and nlst()
APIs into a note that mlsd() is a nicer API if the server supports
it.  They aren't deprecated, they are all different server commands.
Not all servers support all commands.
2015-12-13 22:10:28 -08:00
R David Murray
51a4b22f99 Merge: #25495: Clarify b2a_base64 documentation vis 57 bytes. 2015-12-13 18:04:56 -05:00
R David Murray
2b4f47ee35 #25495: Clarify b2a_base64 documentation vis 57 bytes. 2015-12-13 18:04:27 -05:00
Martin Panter
b82032f935 Issue #22341: Drop Python 2 workaround and document CRC initial value
Also align the parameter naming in binascii to be consistent with zlib.
2015-12-11 05:19:29 +00:00
Martin Panter
7dda421bff Issue #14285: Do not catch exceptions initializing any ancestor package
The previous fix only handled the case of the parent package of __main__
failing to initialize.

Also make the "Error while finding spec" formatting slightly more appealing,
and document and test that the module name must be absolute.
2015-12-10 06:47:06 +00:00
Zachary Ware
3181feb601 Clarify that only *documentation* bugs should go to docs@python.org 2015-12-09 01:53:44 -06:00
Berker Peksag
6e9d2e687b Issue #21240: Add an abstractmethod directive to mark abstract methods in the docs more explicitly 2015-12-08 12:14:50 +02:00
Martin Panter
45be8d67be Issue #25701: Document C API functions that both set and delete objects
Also document that the separate functions that delete objects are preferred;
using PyObject_SetAttr(), _SetAttrString(), and PySequence_SetItem() to
delete is deprecated.
2015-12-08 00:03:20 +00: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
Brett Cannon
f4f25fe576 Issue #25500: Fix the language reference to not claim that import
statements search for __import__ in the global scope.

Thanks to Sergei Lebedev for finding the documentation bug.
2015-12-04 14:51:26 -08:00
Zachary Ware
ee1a0e4b8c Issue #25767: Merge with 3.4 2015-11-30 22:57:01 -06:00
Zachary Ware
992bfe093e Issue #25767: Link to English Wikipedia instead of French. 2015-11-30 22:56:17 -06:00
Martin Panter
9e87f3d79f Issue #22989, #21228: Merge urlopen() doc from 3.4 into 3.5 2015-11-26 11:03:50 +00:00
Martin Panter
747d48cf27 Issues #22989, #21228: Document HTTP response object for urlopen()
Previous documentation was not clear if the geturl(), info() and getcode()
were valid for HTTP responses. The “msg” attribute is different to the usual
HTTPResponse.msg attribute. Based on patch by Evens Fortuné.
2015-11-26 11:01:58 +00:00
Vinay Sajip
46cc4a8f32 Issue #25508: Merged documentation fix from 3.4. 2015-11-24 23:22:48 +00:00
Vinay Sajip
4f44d53770 Issue #25508: Clarify documentation on LogRecord args attribute. 2015-11-24 23:21:15 +00:00
Martin Panter
f7e8d07538 Issue #25576: Merge www-form-urlencoded doc from 3.4 into 3.5 2015-11-24 22:57:46 +00:00
Martin Panter
cda85a0d1c Issue #25576: Remove application/x-www-form-urlencoded charset advice
No charset parameter is standardized for this Content-Type value. Also
clarify that urlencode() outputs ASCII.
2015-11-24 22:33:18 +00:00
Raymond Hettinger
6e701310d1 Issue #25700: Clarify that namedtuple property docstrings became writeable in 3.5 2015-11-23 22:18:55 -08:00
Serhiy Storchaka
1f847659f3 Issue #25706: Fixed markup in the documentation. 2015-11-23 16:43:54 +02:00
Serhiy Storchaka
bf7b9ede1a Issue #25706: Fixed markup in the documentation. 2015-11-23 16:43:05 +02:00
Martin Panter
23244e5787 Issue #25689: Merge ftplib and nntplib docs from 3.4 into 3.5 2015-11-21 22:48:54 +00:00
Martin Panter
828123ce4e Issue #25689: Fix language in ftplib and nntplib docs
Original patch by Silent Ghost.
2015-11-21 22:03:08 +00:00
R David Murray
51d3f8b0ba #25679: spelling fix 2015-11-20 09:57:20 -05:00
Martin Panter
e99e97762c Issue #25626: Change zlib to accept Py_ssize_t and cap to UINT_MAX
The underlying zlib library stores sizes in “unsigned int”. The corresponding
Python parameters are all sizes of buffers filled in by zlib, so it is okay
to reduce higher values to the UINT_MAX internal cap. OverflowError is still
raised for sizes that do not fit in Py_ssize_t.

Sizes are now limited to Py_ssize_t rather than unsigned long, because Python
byte strings cannot be larger than Py_ssize_t. Previously this could result
in a SystemError on 32-bit platforms.

This resolves a regression in the gzip module when reading more than UINT_MAX
or LONG_MAX bytes in one call, introduced by revision 62723172412c.
2015-11-20 08:13:35 +00:00
Ethan Furman
92e5d2f0eb Close issue25594: advise against accessing Enum members from other members 2015-11-20 13:17:27 -08:00
R David Murray
0aaeacb3f1 Merge: #25679: spelling fix 2015-11-20 09:58:51 -05:00
Guido van Rossum
82f9feaf10 Issue #25593: Change semantics of EventLoop.stop(). (Merge 3.4->3.5) 2015-11-19 13:33:34 -08:00
Guido van Rossum
41f69f4cc7 Issue #25593: Change semantics of EventLoop.stop(). 2015-11-19 13:28:47 -08:00
Yury Selivanov
6efc7e726f Merge 3.4 2015-11-18 12:44:49 -05:00
Yury Selivanov
01a65af4a1 asyncio.docs: Fix versionadded 2015-11-18 12:44:31 -05:00
Martin Panter
1535311edc Issue #23200: Merge zlib doc from 3.4 into 3.5 2015-11-18 02:45:51 +00:00
Martin Panter
38fe4dc400 Issue #23200: Document that max_length=0 is not supported 2015-11-18 00:59:17 +00:00
Martin Panter
ce19839961 Issue #20468: Merge getpagesize doc from 3.4 into 3.5 2015-11-17 22:23:21 +00:00
Martin Panter
f8f66eb985 Issue #20468: Remove incorrect information about maxrss and page size
Extract of patch by Ronald Oussoren.
2015-11-17 22:13:47 +00:00
Martin Panter
4eccf4b1ac Issue #25615: Merge glob doc from 3.4 into 3.5 2015-11-17 00:19:10 +00:00
Martin Panter
9f3c094e68 Issue #25615: Document unsorted behaviour of glob; patch by Dave Jones 2015-11-16 23:46:22 +00:00
Yury Selivanov
344904cf1f asyncio.docs: Document Transport.is_closing (merge 3.4) 2015-11-16 12:47:15 -05:00
Yury Selivanov
1744d53930 asyncio.docs: Document Transport.is_closing 2015-11-16 12:46:41 -05:00
Martin Panter
97ce0faa4d Fix grammar in whatsnew/3.5.rst and elsewhere
Mainly missing grammatical articles (the, a).
2015-11-14 01:14:54 +00:00
Martin Panter
32acc16cda Merge typo and grammar fixes from 3.4 into 3.5 2015-11-14 01:14:25 +00:00