d5db14794b
Issue #25179 : Preparatory cleanup of existing docs on string formatting
...
* Various sections were pointing to the section on the string.Formatter
class, when the section on the common format string syntax is probably more
appropriate
* Fix references to various format() functions and methods
* Nested replacement fields may contain conversions and format specifiers,
and this is tested; see Issue #19729 for instance
2016-02-08 01:34:09 +00:00
3df11b2bd6
Fix typo.
...
Reported by Jon Tetlak on docs@
2016-02-02 17:04:41 -06:00
567d513b9b
Issue #26244 : Clarify default zlib compression level in documentation
...
Based on patch by Aviv Palivoda.
2016-02-03 07:06:33 +00:00
b00da57561
Issue #26194 : Inserting into a full deque to raise an IndexError
2016-02-01 21:19:22 -08:00
5f0c5d92ef
Enhance os.scandir() doc
...
Issue #26248 , patch written by Ben Hoyt:
1) Clarify that the return values of is_dir()/is_file()/etc are cached
separately for follow_symlinks True and False.
2) Be more specific about when the functions require a system call, and how it
relates to caching and follow_symlinks.
3) DRY up common stuff between is_dir and is_file by saying "Caching, system
calls made, and exceptions raised are as per is_dir" in is_file.
4) Tweak to the first paragraph of docs for is_dir/is_file to simplify: assume
the follow_symlinks=True default, then note the follow_symlinks=False
non-default case after.
2016-01-31 18:36:41 +01:00
fe5f614418
Issue #26242 : Fix another one in importlib.rst
2016-01-30 19:30:06 +02:00
253739daf4
Fix a markup error in socket.rst
2016-01-30 19:23:29 +02:00
34360c8e09
Issue #19023 : Document ctypes array and pointer classes
...
Also add some more tests. Based on patch by Sye van der Veen.
2016-01-29 10:12:19 +00:00
a370a4271e
Issue #26199 : Fix broken link in unittest.mock-examples.rst
...
Patch by Raphael Das Gupta.
2016-01-28 08:40:03 +02:00
3743432302
Issue #26194 : Fix undefined behavior for deque.insert() when len(d) == maxlen
2016-01-26 21:44:16 -08:00
3bf1d87bbd
Fix a typo in a code example
2016-01-22 14:03:27 -08:00
e5c05cc8c0
minor clarification on Zipfile 'x' mode - exclusive creation of a file.
2016-01-21 21:06:47 -08:00
7405c16533
Issue #18620 : Improve Pool examples in multiprocessing documentation
...
A single call to Pool.apply_async() will create only one process. To use all
of the pool's processes, it should be invoked multiple times:
with Pool(processes=4) as pool:
results = [pool.apply_async(func, ()) for i in range(4)]
Patch by Davin Potts.
2016-01-21 23:59:49 +02:00
6a0514ea20
issue25982 - Add a class definition for managers.Namespace in the multiprocessing docs.
2016-01-20 03:10:13 -08:00
744fdfbf9a
Issue #5626 : Remove misleading comment from socket.gethostname() documentation
...
A machine can have more than one IP addresses so
socket.gethostbyname(socket.gethostname()) probably won't return the correct
one.
2016-01-20 08:45:37 +02:00
49c9edf3d9
Issue #26157 : Fix typos in asyncio-eventloop.rst
...
Initial patch by Carlo Beccarini.
2016-01-20 07:14:22 +02:00
9e9f850f99
issue23962 - Reference the correct TimeoutError in concurrent.futures documentation.
...
Patch contributed by Ryder Lewis.
2016-01-18 18:45:00 -08:00
a82908f743
Issue26035 - Correct the argument names used in the docs of the traceback module. Make it consistent with module args.
...
Patch contributed by Upendra Kumar.
2016-01-15 21:45:17 -08:00
20b1bfa6fb
Issue #26127 : Fix links in tokenize documentation; patch by Silent Ghost
2016-01-16 04:32:52 +00:00
f418db2e8c
#19006 : fix wording in unittest docs.
2016-01-12 11:03:31 +02:00
a7c159ddf3
Issue #25486 : Drop "removed in 3.6" wording from inspect.getargspec docs.
2016-01-11 21:04:50 -05:00
7c018aa377
#25991 : fix readline example to limit history size. Patch by Daniel Dye.
2016-01-11 23:30:56 +02:00
ea471348f4
Fix versionadded to use 3.5.1 only for 3.5 branch
2016-01-11 15:41:43 +02:00
3af81f2505
merge 3.4
2016-01-11 14:45:25 +02:00
f1240169b3
Document asyncio.timeout()
2016-01-11 14:40:35 +02:00
4d927420b8
merge 3.4 ( #26066 )
2016-01-09 23:56:31 -08:00
6829dbbf3f
delete old crypto prose ( closes #26066 )
2016-01-09 23:55:47 -08:00
e95fd0b411
merge 3.4 ( #26046 )
2016-01-07 22:02:01 -08:00
8a6ddb98e6
fix typo in unittest docs ( closes #26046 )
...
Patch from Upendra Kumar.
2016-01-07 22:01:26 -08:00
94541f464c
Issue #5501 : Clarify that invoking freeze_support() on non-Windows platforms has no effect
...
Patch by Davin Potts and Camilla Montonen.
2016-01-07 18:45:22 +02:00
0deaf9ac30
merge from 3.4
...
Issue16544 - Add a link to an external documentation resource in ast module docs.
2016-01-06 21:30:30 -08:00
f3695bfacf
Issue16544 - Add a link to an external documentation resource in ast module docs.
2016-01-06 21:26:53 -08:00
1469d744bc
Cross-reference os.DirEntry and pathlib.Path for issue #22570 .
2016-01-06 11:36:03 -08:00
05075203c5
Add versionadded (3.4.5) to docs for issue #22570 . (Merge 3.4->3.5)
2016-01-06 11:26:36 -08:00
b1360543e5
Add versionadded (3.4.5) to docs for issue #22570 .
2016-01-06 11:23:31 -08:00
406005144b
Docs for issue #22570 . (Merge 3.4->3.5)
2016-01-06 11:16:28 -08:00
df85946e8a
Docs for issue #22570 .
2016-01-06 11:15:52 -08:00
f34c3fe20c
merge from 3.4
...
Issue24898 - Improve str.find documentation.
Simplify str.find explaination as per Georg Brandl's suggestion.
2016-01-03 17:58:24 -08:00
114a1d638e
Issue24898 - Improve str.find documentation.
...
Simplify str.find explaination as per Georg Brandl's suggestion.
2016-01-03 17:57:10 -08:00
6ffbcdf13f
merge from 3.4
...
Issue21221 - Explain the usage of tm_isdst attribute of mktime, with valid
values and meaning.
Patch contributed by Andrew Scheller.
2016-01-03 00:43:23 -08:00
a880800363
Issue21221 - Explain the usage of tm_isdst attribute of mktime, with valid
...
values and meaning.
Patch contributed by Andrew Scheller.
2016-01-03 00:40:03 -08:00
fcb6db50d3
merge from 3.4
...
Issue25917 : Fix howto links in docs. Point the reference documentation instead of wiki.
2016-01-01 23:26:53 -08:00
d03d1d45f5
Issue25917 : Fix howto links in docs. Point the reference documentation instead of wiki.
2016-01-01 23:25:58 -08:00
46a78bc92c
Fix grammar.
...
Reported by Anatoly Techtonik on docs@
2016-01-01 12:22:16 -06:00
01f7ac3bb0
Backport of fix for issue #25930
2015-12-28 17:30:32 -08:00
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
3dc74bf703
docs: Document ASYNC/AWAIT tokens (issue #25580 )
...
Initial patch by SilentGhost
2015-12-17 18:26:41 -05:00
9920e293c3
Merge 3.4
2015-12-16 21:31:04 -05:00
cba0053bef
docs/asyncio: Twek sections names per Nick Coghlan suggestion
2015-12-16 21:30:52 -05:00
e319ab01ce
docs/asyncio: Update ensure_future & run_coroutine_threadsafe docs
2015-12-15 00:45:24 -05:00
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
51a4b22f99
Merge: #25495 : Clarify b2a_base64 documentation vis 57 bytes.
2015-12-13 18:04:56 -05:00
2b4f47ee35
#25495 : Clarify b2a_base64 documentation vis 57 bytes.
2015-12-13 18:04:27 -05:00
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
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
6e9d2e687b
Issue #21240 : Add an abstractmethod directive to mark abstract methods in the docs more explicitly
2015-12-08 12:14:50 +02:00
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
ee1a0e4b8c
Issue #25767 : Merge with 3.4
2015-11-30 22:57:01 -06:00
992bfe093e
Issue #25767 : Link to English Wikipedia instead of French.
2015-11-30 22:56:17 -06:00
9e87f3d79f
Issue #22989 , #21228 : Merge urlopen() doc from 3.4 into 3.5
2015-11-26 11:03:50 +00:00
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
46cc4a8f32
Issue #25508 : Merged documentation fix from 3.4.
2015-11-24 23:22:48 +00:00
4f44d53770
Issue #25508 : Clarify documentation on LogRecord args attribute.
2015-11-24 23:21:15 +00:00
f7e8d07538
Issue #25576 : Merge www-form-urlencoded doc from 3.4 into 3.5
2015-11-24 22:57:46 +00:00
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
6e701310d1
Issue #25700 : Clarify that namedtuple property docstrings became writeable in 3.5
2015-11-23 22:18:55 -08:00
1f847659f3
Issue #25706 : Fixed markup in the documentation.
2015-11-23 16:43:54 +02:00
bf7b9ede1a
Issue #25706 : Fixed markup in the documentation.
2015-11-23 16:43:05 +02:00
23244e5787
Issue #25689 : Merge ftplib and nntplib docs from 3.4 into 3.5
2015-11-21 22:48:54 +00:00
828123ce4e
Issue #25689 : Fix language in ftplib and nntplib docs
...
Original patch by Silent Ghost.
2015-11-21 22:03:08 +00:00
92e5d2f0eb
Close issue25594: advise against accessing Enum members from other members
2015-11-20 13:17:27 -08:00
82f9feaf10
Issue #25593 : Change semantics of EventLoop.stop(). (Merge 3.4->3.5)
2015-11-19 13:33:34 -08:00
41f69f4cc7
Issue #25593 : Change semantics of EventLoop.stop().
2015-11-19 13:28:47 -08:00
6efc7e726f
Merge 3.4
2015-11-18 12:44:49 -05:00
01a65af4a1
asyncio.docs: Fix versionadded
2015-11-18 12:44:31 -05:00
1535311edc
Issue #23200 : Merge zlib doc from 3.4 into 3.5
2015-11-18 02:45:51 +00:00
38fe4dc400
Issue #23200 : Document that max_length=0 is not supported
2015-11-18 00:59:17 +00:00
ce19839961
Issue #20468 : Merge getpagesize doc from 3.4 into 3.5
2015-11-17 22:23:21 +00:00
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
4eccf4b1ac
Issue #25615 : Merge glob doc from 3.4 into 3.5
2015-11-17 00:19:10 +00:00
9f3c094e68
Issue #25615 : Document unsorted behaviour of glob; patch by Dave Jones
2015-11-16 23:46:22 +00:00
344904cf1f
asyncio.docs: Document Transport.is_closing (merge 3.4)
2015-11-16 12:47:15 -05:00
1744d53930
asyncio.docs: Document Transport.is_closing
2015-11-16 12:46:41 -05:00
97ce0faa4d
Fix grammar in whatsnew/3.5.rst and elsewhere
...
Mainly missing grammatical articles (the, a).
2015-11-14 01:14:54 +00:00
32acc16cda
Merge typo and grammar fixes from 3.4 into 3.5
2015-11-14 01:14:25 +00:00
2e4571a456
Fix a few grammar problems in the documentation and comments
2015-11-14 01:07:43 +00:00
ac34e09bbf
Correct Content-Type syntax in documentation
2015-11-14 00:58:32 +00:00
33be3e3d5b
Merge 3.4 (issue #25605 )
2015-11-13 09:14:05 +01:00
9cccfcecc8
Issue #25605 : Document exceptions raised by fcntl.ioctl() and fcntl.flock()
2015-11-13 09:13:48 +01:00
a99ab63d06
Merge with 3.4
2015-11-11 23:33:50 -06:00
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
c730931fa1
Issue #25603 : Add missing parenthesis.
2015-11-11 22:59:44 -06:00
d2f6974240
Improve appearance of example code
2015-11-10 00:09:34 -08:00
549e34cc7b
Remove confusing section from named tuple recipes.
2015-11-10 00:00:00 -08:00
850be0fb18
Improve namedtuple doc string examples
2015-11-09 08:24:53 -08:00
9b566c324d
Issue #25064 : Adjust documentation according to new mkstemp signature
...
The mkstemp() and mkdtemp() signatures have already been updated, but the
higher-level functions still suggest that the default values are forced to
text strings. Also merged some paragraphs describing the "suffix" and
"prefix" parameters, and pointed out that mktemp() does not support the new
changes.
2015-11-07 00:32:50 +00:00
4981dd2cb8
Fixed merging error in 3ebeeed1eb28.
...
Thanks Марк Коренберг.
2015-11-06 11:19:42 +02:00
26825bcb8d
Use sys.platform instead of os.name to detect Windows in asyncio docs. Patch by Akira Li. (Merge 3.4->3.5)
2015-11-02 09:16:37 -08:00
8778c6b77e
Use sys.platform instead of os.name to detect Windows in asyncio docs. Patch by Akira Li.
2015-11-02 09:15:47 -08:00
f51d715845
Issue #25523 : Further a-to-an corrections new in 3.5.
2015-11-02 14:40:41 +02:00
Martin Panter
Zachary Ware
Raymond Hettinger
Victor Stinner
Berker Peksag
Brett Cannon
Senthil Kumaran
Ezio Melotti
Yury Selivanov
Andrew Svetlov
Benjamin Peterson
Guido van Rossum
R David Murray
Gregory P. Smith
Vinay Sajip
Serhiy Storchaka
Ethan Furman