Commit Graph

2964 Commits

Author SHA1 Message Date
Chris Jerdonek f341317185 Issue #16206: Improve the documentation of the dict constructor.
This change includes replacing the single-line signature documentation
with a more complete multiple-line signature.
2012-10-13 03:22:33 -07:00
Ezio Melotti 7fa822275b Fix links to the __next__ method. 2012-10-12 13:42:08 +03:00
Chris Jerdonek 463974916d Issue #16199: Fix typo in 2to3 docs. Thanks to Mark Lawrence for the report. 2012-10-11 15:59:32 -07:00
Chris Jerdonek cc32a68216 Fix placement of shell=True warning in subprocess.Popen() docs. 2012-10-10 22:52:22 -07:00
Chris Jerdonek 4a4a02bbc8 Issue #16115: Make further improvements to subprocess.Popen() documentation. 2012-10-10 17:46:18 -07:00
Georg Brandl a1ff83e556 merge 3.2 heads 2012-10-10 16:49:02 +02:00
Georg Brandl 3a2e101be5 Issue #12947: revert earlier workaround and use a monkey-patch to enable showing doctest directives only in the doctest docs. 2012-10-10 16:45:11 +02:00
Andrew Svetlov a256841b4b Issue #16174: Fix suggested usage of dummy_threading module.
Patch by Berker Peksag.
2012-10-09 13:44:16 +03:00
Chris Jerdonek 470ee39883 Issue #16115: Improve subprocess.Popen() documentation around args, shell, and executable arguments. 2012-10-08 23:06:57 -07:00
Hynek Schlawack 0230b6af78 #13498: Clarify docs of os.makedirs()'s exist_ok argument.
Done with great native-speaker help from R. David Murray.
2012-10-07 18:04:38 +02:00
Chris Jerdonek 83fe2e1c22 Issue #14783: Improve int() docstring and also str(), range(), and slice().
This commit rewrites the docstring for int() to incorporate the documentation
changes made in issue #16036.  It also switches the docstrings for int(),
str(), range(), and slice() to use multi-line signatures.
2012-10-07 14:48:36 -07:00
R David Murray 138a314d1a #9957: document that SpooledTemporaryFile.truncate does not take size arg 2012-10-06 18:26:56 -04:00
Andrew Svetlov afbf90c993 Issue #16025: Minor corrections to the zipfile documentation.
Patch by Serhiy Storchaka.
2012-10-06 18:02:05 +03:00
Ezio Melotti cbd449b416 The file obj passed to ftp.storbinary/storlines must be opened in binary mode. 2012-10-05 14:09:59 +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
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
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 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
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
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
R David Murray 75fd22519f #15636: add versionadded for decodebytes 2012-08-17 20:55:21 -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