Commit Graph

12233 Commits

Author SHA1 Message Date
Andrew Svetlov 8cf1cc498f Issue #16138: fix typo. 2012-10-05 13:26:10 +03:00
Andrew Svetlov f532035551 Close open bracket, thanks to Josh Helzer from docs@ 2012-10-02 18:39:25 +03:00
Ezio Melotti d0fe3e5abb #15979: improve timeit documentation. 2012-10-02 05:35:39 +03:00
R David Murray 6db2335f77 Fix sqlite3 class markup. 2012-09-30 20:44:43 -04:00
Chris Jerdonek ec3ea94251 Issue #15533: Clarify docs and add tests for subprocess.Popen()'s cwd argument. 2012-09-30 00:10:28 -07:00
R David Murray 1a1883d566 #16085: Don't promote shadowing builtins in the configparser example. 2012-09-29 14:40:23 -04:00
R David Murray 5320250485 #16071: fix more email.message links in mailbox docs. 2012-09-28 15:19:16 -04:00
R David Murray c5fe4073af #16071: fix links to email.message.Message in mailbox docs. 2012-09-28 15:09:31 -04:00
Jesus Cea 33b5769db5 Closes #15953: Incorrect some fields declaration in the PyTypeObject documentation 2012-09-28 16:34:45 +02:00
Chris Jerdonek fd448daf77 Close issue #16073: fix map() example in list comprehension documentation.
Thanks for the e-mail report to docs@.
2012-09-28 07:07:12 -07:00
Chris Jerdonek 57491e0703 Issue #16036: Improve documentation of built-in int()'s signature and arguments. 2012-09-28 00:10:44 -07:00
Barry Warsaw 1dedd0a4a4 - Issue #15935: Clarification of argparse docs, re: add_argument() type and
default arguments.  Patch contributed by Chris Jerdonek.
2012-09-25 10:37:58 -04:00
Chris Jerdonek df12f2bbb6 Issue #16015: Make welcome message more realistic in tutorial example. 2012-09-25 04:20:29 -07:00
Chris Jerdonek 9bb56a66c5 Issue #16015: Fix NameError doctest example in tutorial introduction. 2012-09-24 19:28:59 -07:00
Mark Dickinson 05ee5817a1 Issue #14167: restore statement about breaks in finally clauses. 2012-09-24 20:16:38 +01:00
Ezio Melotti 8618fb6a65 #16019, #16020: fix syntax highlight. 2012-09-24 17:30:39 +03:00
Ezio Melotti c926c59d80 #16017: capitalize URLs. 2012-09-24 17:07:39 +03:00
Ezio Melotti 4f24af065d #16014: fix broken link. 2012-09-24 16:56:59 +03:00
Ezio Melotti 20b8d992b0 #15949, #15899: use \ufffd instead of ?. 2012-09-23 15:55:14 +03:00
Ezio Melotti b1d0e5b11e #15949, 15899: avoid using non-latin1 chars in the doc (they break `make all-pdf`). 2012-09-22 11:23:06 +03:00
Mark Dickinson 4e12ad19c9 Issue 15985: fix round argument names in documentation. Thanks Chris Jerdonek. 2012-09-20 20:51:14 +01:00
Ezio Melotti 694f2331c6 Fix a few quotes/backslashes. 2012-09-20 09:47:03 +03:00
Ezio Melotti 8bbcb584dd Fix markup in smtpd.rst. 2012-09-20 09:06:51 +03:00
Ezio Melotti a3ccb237c7 Fix rst markup in timeit docs. 2012-09-20 06:13:38 +03:00
Ezio Melotti 26e5878d6f #11643: fix rst markup error in site.rst. 2012-09-17 08:59:36 +02:00
Ezio Melotti 13bec9b315 #15920: fix doctests in Doc/howto/regex.rst. Patch by Chris Jerdonek. 2012-09-17 05:29:47 +03:00
Ezio Melotti 186d5238ea #15789: mention shell-like parts of the stdlib in the subprocess docs. Patch by Chris Rebert. 2012-09-15 08:34:08 +03:00
Ezio Melotti e34f8a943b #15932: use with statement in csv doc examples. Patch by Dario Bertini. 2012-09-15 05:51:45 +03:00
Ezio Melotti e0add76468 #15831: document multiple signatures on different lines. Patch by Chris Jerdonek. 2012-09-14 06:32:35 +03:00
Ezio Melotti 56f37aa965 #15437, #15439: merge Doc/ACKS.txt with Misc/ACKS and modify Doc/about.rst accordingly. 2012-09-14 01:24:44 +03:00
R David Murray d8bbde35fe #14617: clarify discussion of interrelationship of __eq__ and __hash__. 2012-09-11 13:01:43 -04:00
Senthil Kumaran 2fd8bdbc9d Fix issue #15899: Make the unicode.rst doctests pass. Patch by Chris Jerdonek. 2012-09-11 03:17:52 -07:00
R David Murray 5abd76a75d #14649: clarify DocTestSuite error when there are no docstrings.
Also adds tests to verify the documented behavior (which is probably a bug, as
indicated in the added comments).

Patch by Chris Jerdonek.
2012-09-10 10:15:58 -04:00
Richard Oudkerk b517596721 Issue #15901: Change example to use byte string instead of string 2012-09-10 13:00:33 +01:00
Alexander Belopolsky 7330da4297 Issue #15881: Added NEWS entry and proper credit. 2012-09-09 14:11:45 -04:00
Alexander Belopolsky 59fb38b582 Issue #15881: Fixed atexit hook in multiprocessing. 2012-09-09 13:16:15 -04:00
R David Murray 14d66a98ed #5088: document behavior of optparse defaults with 'append' action. 2012-09-08 16:45:35 -04:00
Ezio Melotti 8bdcdc235e Merge heads. 2012-09-08 20:52:19 +03:00
Ezio Melotti e927e25637 #15865: add "*" in the signature to document keyword-only args in the docs. Patch by Chris Jerdonek. 2012-09-08 20:46:01 +03:00
R David Murray 1585b70813 #15510: clarify textwrap's handling of whitespace, and add confirming tests.
Patch by Chris Jerdonek.
2012-09-08 13:13:25 -04:00
Andrew Svetlov ff63e7afcf Issue #15825: fix typo in OrderedDict docs.
Patch by Mike Hoy.
2012-08-31 13:54:54 +03:00
Ezio Melotti 49ccd514d2 Add missing comma. 2012-08-29 17:50:42 +03:00
Petri Lehtinen 72b1426cfb #11964: Document a change in v3.2 to the json indent parameter 2012-08-28 07:08:44 +03:00
Petri Lehtinen 72c6eefcc6 Fix a JSON doc typo 2012-08-27 20:27:30 +03:00
Ezio Melotti aa935dfe9c #15788: fix broken links in subprocess doc. Patch by Chris Rebert. 2012-08-27 10:00:05 +03:00
Antoine Pitrou 15251a99bb Add glossary references 2012-08-24 19:49:08 +02:00
Antoine Pitrou 331624b67d Issue #14674: Add a discussion of the json module's standard compliance.
Patch by Chris Rebert.
2012-08-24 19:37:23 +02:00
Antoine Pitrou 9439f04b9a Issue #14954: Clarify the interaction of weak references and garbage collection.
Patch by Ethan Furman.
2012-08-21 00:07:07 +02:00
R David Murray f6bd1b0e0d #15742: clarify sqlite parameter substitution example.
Suggestion and patch by Mike Hoy.
2012-08-20 14:14:18 -04:00
R David Murray e56bf97ef4 #13579: teach string.Formatter about 'a'.
Patch by Francisco Martín Brugué.
2012-08-19 17:26:34 -04:00
Eli Bendersky 31a11902b3 tutorial typo fix 2012-08-18 09:50:09 +03:00
R David Murray 75fd22519f #15636: add versionadded for decodebytes 2012-08-17 20:55:21 -04:00
R David Murray 2c1d1d6310 #15355: Mention already-executing Exception in generator docs.
Patch by Chris Jerdonek.
2012-08-17 20:48:59 -04:00
R David Murray 433ef3b5c3 #15694: reflow paragraph. 2012-08-17 20:39:21 -04:00
R David Murray 9f0c9401d3 #15694: Link discussion of file objects to glossary entry.
This is analogous to the link for `flie objects` in the description of
'open' that exists in the 2.7 docs, and adds a similar link to the
io docs.

Patch by Chris Jerdonek.
2012-08-17 20:33:54 -04:00
Terry Jan Reedy f6190c1463 Issue 15660: Clarify 0 prefix for width field in str.format doc. 2012-08-17 15:40:46 -04:00
Richard Oudkerk d9c026fd77 Issue #15412: Remove erroneous note about weakrefs 2012-08-17 15:02:47 +01:00
Richard Oudkerk 264e9ac5f5 Issue #14501: Clarify that authentication keys are byte strings 2012-08-17 14:39:18 +01:00
Antoine Pitrou b7c6c8105e Update the getpeercert() example with a real-world cert showing non-trivial issuer, subject and subjectAltName. 2012-08-16 22:14:43 +02:00
Sandro Tosi dd7c55250d clarify in/not in in case of infinite iterators; thanks to Sergey Skovorodkin from docs@ 2012-08-15 21:37:35 +02:00
R David Murray ee0a945ae4 #15543: reflow paragraphs. 2012-08-15 11:05:36 -04:00
R David Murray 1b00f25bf9 #15543: glossary entry for and 'universal newlines', and links to it.
Patch by Chris Jerdonek.
2012-08-15 10:43:58 -04:00
Eli Bendersky 8f773493b6 Issue #15656: fixing code sample in extending doc 2012-08-15 14:49:49 +03:00
R David Murray 2b209cd78d #15269: document dircmp.left and right, and add tests for them.
Patch by Chris Jerdonek.
2012-08-14 21:40:13 -04:00
Sandro Tosi a17ef14632 fix typo 2012-08-14 19:51:43 +02:00
Andrew Svetlov f158d86074 Issue #14167: Document return statement in finally blocks.
Patch by Yury Selivanov.
2012-08-14 15:38:15 +03:00
Georg Brandl 296d1bea6a Restore original line lengths. 2012-08-14 09:39:07 +02:00
Andrew Svetlov 59db401667 Issue #15497: Correct characters in TextWrapper.replace_whitespace docs.
Patch by Chris Jerdonek.
2012-08-13 23:22:23 +03:00
Andrew Svetlov 50be452e0f Issue #15561: Update subprocess docs to reference io.TextIOWrapper.
Patch by Chris Jerdonek.
2012-08-13 22:09:04 +03:00
Andrew Svetlov ecd78feb78 Issue #15624: clarify newline documentation for open and io.TextIOWrapper
Thanks to Chris Jerdonek
2012-08-13 12:58:02 +03:00
Senthil Kumaran 1ef9caa2a1 Issue #15630: Add an example for "continue" statement in the tutorial. Patch by
Daniel Ellis.
2012-08-12 12:01:47 -07:00
Sandro Tosi c7b0e217e2 add usage example from cli; thanks to Christian Clauss from docs@ 2012-08-12 17:34:00 +02:00
Sandro Tosi 6cbe405a20 escape '\'; thanks to Steve Holden from docs@ 2012-08-12 15:35:25 +02:00
Sandro Tosi 985104a20c it's getstatus() not setstatus(); thanks to Shaddi Hasan from docs@ 2012-08-12 15:12:15 +02:00
Sandro Tosi 82a509ca75 add missing quote in splitlines() example; thanks to Yevgen Yampolskiy from docs@ 2012-08-12 12:35:14 +02:00
Sandro Tosi 8b2c71a125 update Geany URL; thanks to Karl Tarbet from docs@ 2012-08-12 11:02:03 +02:00
Sandro Tosi ee903c5125 add missing parenthesis to 'action' argparse doc; thanks to kishkin from docs@ 2012-08-12 10:49:26 +02:00
Sandro Tosi 0a90a82b8a zip() returns an iterator, make a list() of it; thanks to Martin from docs@ 2012-08-12 10:24:50 +02:00
Antoine Pitrou fbd4f80979 Issue #15444: Use proper spelling for non-ASCII contributor names.
Patch by Serhiy Storchaka.
2012-08-11 16:51:50 +02:00
Andrew Svetlov 7dbee38564 fix docs for c-api memory functions 2012-08-09 21:26:34 +03:00
Andrew Svetlov eec6420de4 Issue #15501: Document exception classes in subprocess module.
Initial patch by Anton Barkovsky.
2012-08-09 15:20:45 +03:00
R David Murray 05c35a6a6b #15554: clarify splitlines/split differences.
Patch by Chris Jerdonek.
2012-08-06 16:08:09 -04:00
Brett Cannon 9b000e7a68 Issue #15482: Properly document the default 'level' parameter for
__import__().

To help explain why the -1 default value is typically not seen, a note
about how import statements only use values of >= 0 is also noted.
2012-08-05 20:46:25 -04:00
Sandro Tosi da9df92068 add missing period; thanks to Gaston Fiore from docs@ 2012-08-04 19:42:24 +02:00
Victor Stinner 401e17d0f0 open() / TextIOWrapper doc: make it explicit than newline='\n' doesn't
translate newlines on output.
2012-08-04 01:18:56 +02:00
Antoine Pitrou 0c1c0d42dc Make TextIOWrapper's documentation clearer by copying the newline argument's description from open(). 2012-08-04 00:55:38 +02:00
Eli Bendersky f37c0c73fe Issue #15321: update PyPI upload doc to say --no-raw passed to rst2html.py 2012-08-02 02:56:39 +03:00
Vinay Sajip a58d668fd9 Improved cookbook entry and fixed typo. 2012-07-27 10:54:10 +01:00
Andrew Svetlov e708a8a4aa Issue #15041: update "see also" list in tkinter documentation. 2012-07-26 17:02:57 +03:00
Antoine Pitrou 707bd4e385 Mention the *limit* argument of TextIO.readline(). 2012-07-25 22:38:33 +02:00
Vinay Sajip 393e23fbb5 Issue #15445: Updated logging configuration documentation to highlight potential security risk posed by listen() in certain scenarios. 2012-07-25 19:19:25 +01:00
Jesus Cea 55624da8a8 Rollback an incorrect Doc/ACKS.txt entry 2012-07-23 18:42:37 +02:00
Jesus Cea 189fdf187b Better test for Issue #15402: Add a __sizeof__ method to struct.Struct 2012-07-23 18:15:33 +02:00
Senthil Kumaran 28a9f2193a - Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch contributed by Chris Jerdonek. 2012-07-22 19:12:58 -07:00
R David Murray e60e12b57a #15429: Fix invalid mention of types.NoneType from None docs. 2012-07-22 20:43:13 -04:00
Vinay Sajip 3be7a8bbcf Issue #15399: Added versionchanged for processName. 2012-07-20 09:50:18 +01:00
Jesus Cea ef86d12979 Closes #15396: memory leak in tkinter 2012-07-19 21:18:07 +02:00
Nick Coghlan a3d1cac4b2 Issue #15230: Update runpy docs to clarify a couple of points that came up in this issue 2012-07-15 00:36:39 +10:00
Antoine Pitrou 52cc722ab8 Add c_size_t and c_ssize_t to the ctypes summary table. 2012-07-12 20:31:50 +02:00
Raymond Hettinger 921d1244c6 Show the proper way to exit a cmd shell 2012-07-12 11:26:01 -07:00
Terry Jan Reedy 83efd6cbb6 Issue #13557: Clarify effect of giving two different namespaces to exec or
execfile().
2012-07-08 17:36:14 -04:00
Georg Brandl 29feb1ffca Make call of os.getppid() conditional: it is not available on Windows. 2012-07-01 09:47:54 +02:00
Georg Brandl 3aa0c9dcf3 Fix inconsistent function name in embedding howto. 2012-07-01 09:43:20 +02:00
Senthil Kumaran 4a27d9fb46 urlparse docs clean up - no reference to earlier draft 2012-06-28 21:07:58 -07:00
Antoine Pitrou 2d24e94bbe Issue #5067: improve some json error messages.
Patch by Serhiy Storchaka.
2012-06-29 01:58:26 +02:00
Senthil Kumaran 72a80e85a8 issue13666 - Fixing datetime documentation example when using tzinfo 2012-06-26 20:00:15 +08:00
Senthil Kumaran f21804ad61 Issue #13685 - Update argparse help message for % sign usage. 2012-06-26 14:17:19 +08:00
Georg Brandl 33369cf9a5 Fix a bunch of "versionchanged" related markup errors. 2012-06-24 22:48:03 +02:00
Mark Dickinson b8dc3ab08b Issue #12965: More PyLong_As* clarifications. Thanks Stefan Krah. 2012-06-23 12:12:52 +01:00
Mark Dickinson f0acfeeccf Issue #12965: Clean up C-API docs for PyLong_AsLongLong(AndOverflow); clarify that __int__ will be called for non-PyLongs 2012-06-23 11:14:22 +01:00
Mark Dickinson 0a22924d52 Issue #12965: Clean up C-API docs for PyLong_AsLong(AndOverflow); clarify that __int__ will be called for non-PyLongs 2012-06-23 10:49:12 +01:00
Ezio Melotti f90ea1f0a0 #14840: Add a bit on the difference between tuples and lists. Initial patch by Zachary Ware. 2012-06-17 14:10:59 +02:00
Antoine Pitrou 13775221e0 Issue #14933: fix misleading doc about weakref support in extension types. 2012-06-15 19:11:31 +02:00
Sandro Tosi 27b130e702 Issue #15060: better fix, thanks to review on #python-dev 2012-06-14 00:37:09 +02:00
Sandro Tosi 56692f5722 Issue #15060: fix typo in socket doc; Patch by anatoly techtonik 2012-06-13 23:58:54 +02:00
Nick Coghlan a3a164a03c Nudge readers towards a more accurate mental model for loop else clauses 2012-06-07 22:41:34 +10:00
Sandro Tosi 7f671338de backport c4bd68be5fc6 to 3.2 2012-06-02 23:41:19 +02:00
Sandro Tosi 964f205a34 refer to time.strftime 2012-06-02 18:22:02 +02:00
R David Murray 554b3481fa #14957: fix doc typo. 2012-06-02 11:20:29 -04:00
R David Murray ae1b94b6e4 #14957: clarify splitlines docs.
Initial patch by Michael Driscoll, I added the example.
2012-06-01 16:19:36 -04:00
Sandro Tosi 3f7d1d3303 Issue #14968: set 'Inplace Operators' as subsection; patch by Lars Buitinck 2012-06-01 20:23:20 +02:00
Brian Curtin 13c70345ca Fix #14943. Update the proper default value and list the proper argument names in the explanation. 2012-05-29 18:34:45 -05:00
R David Murray e1398f77ea #11785: fix the :mod: references in email package submodule titles. 2012-05-27 17:17:53 -04:00
Petri Lehtinen 1a01ebc41c #14863: Update the documentation of os.fdopen()
There's no bufsize argument anymore, and os.fdopen() is only a very
thin wrapper around open() anymore. Change the documentation to
reflect that.
2012-05-24 21:46:36 +03:00
Hynek Schlawack 979f37afd2 Restore [] where default arguments are not keywords
Reverts some changes of d13fdd97cc8e.
2012-05-22 16:12:18 +02:00
Hynek Schlawack dfa465243c #14804: Remove [] around optional arguments with default values 2012-05-21 11:01:54 +02:00
Hynek Schlawack f54c0604c8 Fix `versionchanged` tags for json.load
`versionchanged` tags about 2.7 are useless in 3.x branches.
2012-05-20 18:32:53 +02:00
Vinay Sajip 69d8493899 Fixes #14864: Added documentation on how to undo the effects of a logging.disable() call. 2012-05-20 15:36:17 +01:00
Hynek Schlawack 1203e83d28 Document when json.load's parse_constant behaviour changed
It doesn't get called on 'null', 'true', 'false' since f686aced02a3.
2012-05-20 12:03:17 +02:00
Petri Lehtinen 079bfc962d #14494: Document that absolute imports became default in 3.0 instead of 2.7. 2012-05-19 18:36:33 +03:00
Petri Lehtinen 1033b310a3 Fix time.time() references in the time module docs
Closes #14842.
2012-05-18 21:22:47 +03:00
R David Murray f7a6615719 #14823: Simplify threading.Lock.acquire argument discussion. 2012-05-17 09:13:30 -04:00
Hynek Schlawack 9729fd4427 #14692 Fix json docs to reflect changes in json.load
The behaviour of the parse_constant callback changed insofar that 'null',
'true', 'false' don't trigger its call anymore.

Patch by Serhiy Storchaka
2012-05-16 19:01:04 +02:00
R David Murray 28e68ea6ea #1440472: reflow 2012-05-15 22:13:29 -04:00
R David Murray ea1badbfef #1440472: Explain that email parser/generator isn't *quite* "idempotent" 2012-05-15 22:07:52 -04:00
R David Murray 539f239e88 #14766: Reflow the altered paragraphs. 2012-05-14 22:17:23 -04:00
R David Murray 9075d8b771 #14766: Add correct algorithm for when a 'time' object is naive.
This patch also clarifies the definition of Naive and Aware.

Original patch by Greg Weller, I modified the first hunk
somewhat to make the exposition even clearer (I hope).
2012-05-14 22:14:46 -04:00
Ezio Melotti e768b06f16 #14405: remove outdated/broken/duplicate links. 2012-05-14 13:26:45 +03:00
Mark Dickinson ba3b0d84bd Issue #14245: Improve floating-point entry in FAQ. Thanks Zbyszek Jędrzejewski-Szmek for some of the wording. 2012-05-13 21:00:35 +01:00
Ezio Melotti b35480e1d2 #14770: improve the library FAQ. 2012-05-13 20:14:04 +03:00
Sandro Tosi 3918b1ebfb Issue #14793: fix grammar in bytes object paragraph; patch by Tshepang Lekhonkhobe 2012-05-13 11:01:20 +02:00
Sandro Tosi 38b86b4cf5 correctly define what 'fill' could be; thanks to Leland Hulbert from docs@ 2012-05-12 23:29:32 +02:00
Antoine Pitrou a9494f6c53 Some nits in the pickle docs. 2012-05-10 15:38:30 +02:00
Antoine Pitrou cc6c673a69 Removed outdated statement about pickle's and marshal's relative performance. 2012-05-10 15:18:20 +02:00
Ezio Melotti bf3165b971 #14763: document default maxsplit value for str.split. 2012-05-10 15:30:42 +03:00
R David Murray b98b37f101 Improve the grammar of a non-sentence. 2012-05-08 21:28:24 -04:00
Georg Brandl 0958a4d63d Fix document title for Sphinx. 2012-05-06 21:39:35 +02:00
Ezio Melotti 9ab3fdd8cb #14034: fix indentation. 2012-05-06 17:05:16 +03:00
Ezio Melotti 6cc7a41c2f #14034: added the argparse tutorial. Patch by Tshepang Lekhonkhobe. 2012-05-06 16:15:35 +03:00
Ned Deily 2e20968feb Issue #10433: Document unique behavior of 'os.getgroups' on Mac OS X. 2012-04-30 11:14:02 -07:00