Commit graph

7258 commits

Author SHA1 Message Date
Martin Panter
96a4f07107 Issues #26310, #26311: Fix typos in the documentation and code comments 2016-02-10 01:17:51 +00:00
Gregory P. Smith
e27403b75f Clarify "cardinality of" as "number of elements in" as many readers do
not have a math vocabulary.
2016-02-08 09:58:40 -08:00
Martin Panter
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
Zachary Ware
3df11b2bd6 Fix typo.
Reported by Jon Tetlak on docs@
2016-02-02 17:04:41 -06:00
Martin Panter
567d513b9b Issue #26244: Clarify default zlib compression level in documentation
Based on patch by Aviv Palivoda.
2016-02-03 07:06:33 +00:00
Raymond Hettinger
b00da57561 Issue #26194: Inserting into a full deque to raise an IndexError 2016-02-01 21:19:22 -08:00
Victor Stinner
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
Berker Peksag
fe5f614418 Issue #26242: Fix another one in importlib.rst 2016-01-30 19:30:06 +02:00
Berker Peksag
253739daf4 Fix a markup error in socket.rst 2016-01-30 19:23:29 +02:00
Martin Panter
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
Berker Peksag
a370a4271e Issue #26199: Fix broken link in unittest.mock-examples.rst
Patch by Raphael Das Gupta.
2016-01-28 08:40:03 +02:00
Raymond Hettinger
3743432302 Issue #26194: Fix undefined behavior for deque.insert() when len(d) == maxlen 2016-01-26 21:44:16 -08:00
Brett Cannon
3bf1d87bbd Fix a typo in a code example 2016-01-22 14:03:27 -08:00
Senthil Kumaran
e5c05cc8c0 minor clarification on Zipfile 'x' mode - exclusive creation of a file. 2016-01-21 21:06:47 -08:00
Berker Peksag
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
Senthil Kumaran
6a0514ea20 issue25982 - Add a class definition for managers.Namespace in the multiprocessing docs. 2016-01-20 03:10:13 -08:00
Berker Peksag
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
Berker Peksag
49c9edf3d9 Issue #26157: Fix typos in asyncio-eventloop.rst
Initial patch by Carlo Beccarini.
2016-01-20 07:14:22 +02:00
Senthil Kumaran
9e9f850f99 issue23962 - Reference the correct TimeoutError in concurrent.futures documentation.
Patch contributed by Ryder Lewis.
2016-01-18 18:45:00 -08:00
Senthil Kumaran
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
Martin Panter
20b1bfa6fb Issue #26127: Fix links in tokenize documentation; patch by Silent Ghost 2016-01-16 04:32:52 +00:00
Ezio Melotti
f418db2e8c #19006: fix wording in unittest docs. 2016-01-12 11:03:31 +02:00
Yury Selivanov
a7c159ddf3 Issue #25486: Drop "removed in 3.6" wording from inspect.getargspec docs. 2016-01-11 21:04:50 -05:00
Ezio Melotti
7c018aa377 #25991: fix readline example to limit history size. Patch by Daniel Dye. 2016-01-11 23:30:56 +02:00
Andrew Svetlov
ea471348f4 Fix versionadded to use 3.5.1 only for 3.5 branch 2016-01-11 15:41:43 +02:00
Andrew Svetlov
3af81f2505 merge 3.4 2016-01-11 14:45:25 +02:00
Andrew Svetlov
f1240169b3 Document asyncio.timeout() 2016-01-11 14:40:35 +02:00
Benjamin Peterson
4d927420b8 merge 3.4 (#26066) 2016-01-09 23:56:31 -08:00
Benjamin Peterson
6829dbbf3f delete old crypto prose (closes #26066) 2016-01-09 23:55:47 -08:00
Benjamin Peterson
e95fd0b411 merge 3.4 (#26046) 2016-01-07 22:02:01 -08:00
Benjamin Peterson
8a6ddb98e6 fix typo in unittest docs (closes #26046)
Patch from Upendra Kumar.
2016-01-07 22:01:26 -08:00
Berker Peksag
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
Senthil Kumaran
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
Senthil Kumaran
f3695bfacf Issue16544 - Add a link to an external documentation resource in ast module docs. 2016-01-06 21:26:53 -08:00
Guido van Rossum
1469d744bc Cross-reference os.DirEntry and pathlib.Path for issue #22570. 2016-01-06 11:36:03 -08:00
Guido van Rossum
05075203c5 Add versionadded (3.4.5) to docs for issue #22570. (Merge 3.4->3.5) 2016-01-06 11:26:36 -08:00
Guido van Rossum
b1360543e5 Add versionadded (3.4.5) to docs for issue #22570. 2016-01-06 11:23:31 -08:00
Guido van Rossum
406005144b Docs for issue #22570. (Merge 3.4->3.5) 2016-01-06 11:16:28 -08:00
Guido van Rossum
df85946e8a Docs for issue #22570. 2016-01-06 11:15:52 -08:00
Senthil Kumaran
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
Senthil Kumaran
114a1d638e Issue24898 - Improve str.find documentation.
Simplify str.find explaination as per Georg Brandl's suggestion.
2016-01-03 17:57:10 -08:00
Senthil Kumaran
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
Senthil Kumaran
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
Senthil Kumaran
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
Senthil Kumaran
d03d1d45f5 Issue25917 : Fix howto links in docs. Point the reference documentation instead of wiki. 2016-01-01 23:25:58 -08:00
Zachary Ware
46a78bc92c Fix grammar.
Reported by Anatoly Techtonik on docs@
2016-01-01 12:22:16 -06:00
Brett Cannon
01f7ac3bb0 Backport of fix for issue #25930 2015-12-28 17:30:32 -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