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
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
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
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
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
Ethan Furman
92e5d2f0eb
Close issue25594: advise against accessing Enum members from other members
2015-11-20 13:17:27 -08: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
Martin Panter
2e4571a456
Fix a few grammar problems in the documentation and comments
2015-11-14 01:07:43 +00:00
Martin Panter
ac34e09bbf
Correct Content-Type syntax in documentation
2015-11-14 00:58:32 +00:00
Victor Stinner
33be3e3d5b
Merge 3.4 (issue #25605 )
2015-11-13 09:14:05 +01:00
Victor Stinner
9cccfcecc8
Issue #25605 : Document exceptions raised by fcntl.ioctl() and fcntl.flock()
2015-11-13 09:13:48 +01:00
Zachary Ware
a99ab63d06
Merge with 3.4
2015-11-11 23:33:50 -06:00
Zachary Ware
71a0b43854
Rewrite re.VERBOSE section.
...
It now has slightly better rationale and a less awkward wording in the
explanation.
Inspired by a report of a neither/or conflict by 'animalize' on docs@.
2015-11-11 23:32:14 -06:00
Zachary Ware
c730931fa1
Issue #25603 : Add missing parenthesis.
2015-11-11 22:59:44 -06:00
Raymond Hettinger
d2f6974240
Improve appearance of example code
2015-11-10 00:09:34 -08:00
Raymond Hettinger
549e34cc7b
Remove confusing section from named tuple recipes.
2015-11-10 00:00:00 -08:00
Raymond Hettinger
850be0fb18
Improve namedtuple doc string examples
2015-11-09 08:24:53 -08:00