Commit Graph

7725 Commits

Author SHA1 Message Date
Martin Panter 53ae0ba6e3 Issue #26304: Change "allows to <verb>" to "allows <verb>ing" or similar
The original form is incorrect grammar and feels awkward, even though the
meaning is clear.
2016-02-10 05:44:01 +00:00
Martin Panter 2dafcc25a9 Issues #26310, #26311: Fix typos in the documentation 2016-02-10 01:17:51 +00:00
Gregory P. Smith 3b5d61fa6c Clarify "cardinality of" as "number of elements in" as many readers do
not have a math vocabulary.
2016-02-08 09:59:14 -08:00
Martin Panter 00f19eff3e Issue #25179: Preparatory cleanup of existing docs on string formatting
* There was a link pointing to the section on the string.Formatter class (and
  multiple links in Python 3), 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 in Python 3; see Issue #19729 for instance
2016-02-08 01:34:09 +00:00
Martin Panter 1d269c1067 Issue #26244: Clarify default zlib compression level in documentation
Based on patch by Aviv Palivoda.
2016-02-03 07:06:33 +00:00
Martin Panter a339e86dc0 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 b031adcd51 Fix typo in test.rst
Reported by Mike Scalora on docs@p.o.
2016-01-25 08:24:57 +02:00
Berker Peksag f9aa599c0a 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-22 00:07:00 +02:00
Senthil Kumaran 762d761d65 issue25982 - Add a class definition for managers.Namespace in the multiprocessing docs. 2016-01-20 03:18:48 -08:00
Senthil Kumaran 11a73890d3 Issue26035 - Correct the argument names used in the docs of the traceback module. Make it consistent with module args. 2016-01-15 22:13:16 -08:00
Martin Panter 264dcb7290 Issue #26127: Fix links in tokenize documentation 2016-01-16 04:32:52 +00:00
Senthil Kumaran 1826f6369c Issue26097 - Fix the TextTestRunner documentation, mention all the arguments of the class.
Patch contributed by Nicolas Évrard.
2016-01-14 21:57:57 -08:00
Ezio Melotti 7f62062be1 #19006: fix wording in unittest docs. 2016-01-12 11:03:10 +02:00
Ezio Melotti 167c336725 #25991: fix readline example to limit history size. Patch by Daniel Dye. 2016-01-11 23:30:15 +02:00
Benjamin Peterson c2ccb73e8a delete old crypto prose (closes #26066) 2016-01-09 23:55:47 -08:00
Benjamin Peterson c6fa90c7ca fix typo in unittest docs (closes #26046)
Patch from Upendra Kumar.
2016-01-07 22:01:26 -08:00
Berker Peksag 6b51ddfa22 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:49:53 +02:00
Senthil Kumaran e2e6b54a4c Backport documentation improvement.
Issue24898 - Improve str.find documentation.

Simplify str.find explaination as per Georg Brandl's suggestion.
2016-01-03 18:07:06 -08:00
Senthil Kumaran 8a4e7fd678 Backport doc improvements for Issue21221 - Explain the usage of tm_isdst
attribute of mktime, with valid values and meaning.

Patch contributed by Andrew Scheller.
2016-01-03 01:03:40 -08:00
Zachary Ware fa45a0e3d2 Fix grammar.
Reported by Anatoly Techtonik on docs@
2016-01-01 12:22:16 -06:00
Martin Panter d77fe94b4e Issue #22088: Port base64 character ignoring doc and test from 857d9fe60169 2015-12-14 03:41:59 +00:00
Martin Panter edd6a817d1 Issue #20837: Base-64 alphabet clarification from revision 1853679c6f71 2015-12-14 02:54:40 +00:00
R David Murray b75adccd0a #25495: Clarify b2a_base64 documentation vis 57 bytes. 2015-12-13 18:04:14 -05:00
Vinay Sajip c9625c8e4b Issue #25508: Clarify documentation on LogRecord args attribute. 2015-11-24 23:18:30 +00:00
Martin Panter 402803b642 Issue #23200: Document that max_length=0 is not supported 2015-11-18 00:59:17 +00:00
Martin Panter 793ae0d0ae 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 a5d1cf3221 Issue #25615: Document unsorted behaviour of glob; patch by Dave Jones 2015-11-16 23:46:22 +00:00
Martin Panter 5118f7b9af Issue #25017: Document that htmllib is superseded by module HTMLParser 2015-11-14 00:30:46 +00:00
Victor Stinner c0fdd825c2 Issue #25605: Document exceptions raised by fcntl.ioctl() and fcntl.flock() 2015-11-13 09:13:16 +01:00
Zachary Ware db7a1d6e15 Document the BUILD_SET opcode.
Reported by Hrvoje Abraham on docs@.
2015-11-12 10:02:06 -06:00
Zachary Ware 77d61d4156 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
Serhiy Storchaka c72e66a048 Issue #25523: Backported a-to-an corrections. 2015-11-02 15:06:09 +02:00
Terry Jan Reedy a5ad9da504 Issue #25519: Mark difflib.ndiff as a functions where not already. 2015-10-30 19:41:10 -04:00
Terry Jan Reedy 0a1ba70949 Issue #25432: Explain isinstance behaviour when type is a tuple. 2015-10-28 03:14:46 -04:00
Victor Stinner 15a43ed030 Issue #25461: Rephrase os.walk() doc
Patch written by Bernt Røskar Brenna.
2015-10-23 12:42:39 +02:00
Terry Jan Reedy 1c49ec0df0 Issue #24782: Finish converting the Configure Extension dialog into a new
tab in the IDLE Preferences dialog.  Code patch by Mark Roseman.
2015-10-13 22:03:44 -04:00
Martin Panter 4ed35fc4f3 Issue #25161: Add full stops in documentation; patch by Takase Arihiro 2015-10-10 10:52:35 +00:00
Martin Panter dab305ef05 Issue #22413: Document newline effect on StringIO initializer and getvalue
Also add to comment in the C code.
2015-10-10 02:52:30 +00:00
Martin Panter 4a33724d47 Issue #25286: Dictionary views are not sequences
Also change glossary heading from "view" to "dictionary view". Patch by Akira
Li.
2015-10-07 10:19:39 +00:00
Martin Panter fcf58a1518 Issue #16701: Document += and *= for mutable sequences 2015-10-03 07:37:22 +00:00
Terry Jan Reedy 195fc2f2aa Issue #25224: README.txt is now an idlelib index for IDLE developers and
curious users.  The previous user content is now in the IDLE doc and is
redundant.  IDLE now means 'Integrated Development and Learning Environment'.
2015-10-02 23:22:54 -04:00
Terry Jan Reedy 958a9c7520 Issue #24028: Add subsection about Idle calltips. 2015-09-29 01:55:50 -04:00
Benjamin Peterson 4e648f6c07 make wikipedia link https 2015-09-27 02:05:01 -07:00
Benjamin Peterson 9b4865ad2b shorten and fix casing of title 2015-09-27 01:23:10 -07:00
Terry Jan Reedy f56f8d1800 Issue #25225: Condense and rewrite Idle doc section on text colors. 2015-09-24 23:13:43 -04:00
Terry Jan Reedy 7cca4e5ba2 Issue 21995: Explain some differences between IDLE and console Python. 2015-09-24 03:09:38 -04:00
Victor Stinner 68dafe5f14 Issue #24894: Document the codec iso8859_11
Patch written by Prashant Tyagi.
2015-09-24 09:05:19 +02:00
Terry Jan Reedy cf5bf82e59 Issue #22820: Explain need for *print* when running file from Idle editor. 2015-09-24 01:39:25 -04:00
Terry Jan Reedy 6741a5ae19 Issue 25224: Augment Idle doc feature list and no-subprocess section
to finish making current README.txt obsolete.
2015-09-23 20:00:22 -04:00
Terry Jan Reedy c7025c6265 Issue #25219: Update doc for Idle command line options.
Some were missing and notes were not correct.
2015-09-23 03:52:18 -04:00