Commit Graph

12481 Commits

Author SHA1 Message Date
R David Murray 8d580539f0 #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:17:13 -04:00
R David Murray b9495c78a1 closes #5088: document behavior of optparse defaults with 'append' action. 2012-09-08 16:47:24 -04:00
R David Murray 1b6e7c47f2 #15510: clarify textwrap's handling of whitespace, and add confirming tests.
Patch by Chris Jerdonek.
2012-09-08 13:42:01 -04:00
Petri Lehtinen f9e1f1128b #13769: Enhance docs for ensure_ascii semantics in JSON decoding functions 2012-09-01 07:29:06 +03:00
Andrew Svetlov 2b326e4c2b Issue #15825: fix typo in OrderedDict docs.
Patch by Mike Hoy.
2012-08-31 13:53:30 +03:00
Ezio Melotti 6bb9c73b06 Add missing comma. 2012-08-29 17:50:42 +03:00
Vinay Sajip 3d212e6ee5 Closes #15807: Removed incorrect directive from help. 2012-08-29 14:25:42 +01:00
Hynek Schlawack 7d978902d0 #14880: Fix kwargs notation in csv.reader, .writer & .register_dialect
Patch by Chris Rebert.
2012-08-28 12:33:46 +02:00
Ezio Melotti 8662c84ac8 #15788: fix broken links in subprocess doc. Patch by Chris Rebert. 2012-08-27 10:00:05 +03:00
Antoine Pitrou 85ede8da00 Add glossary references 2012-08-24 19:49:08 +02:00
Antoine Pitrou f3e0a69d88 Issue #14674: Add a discussion of the json module's standard compliance.
Patch by Chris Rebert.
2012-08-24 19:46:17 +02:00
Georg Brandl e565cf805d Remove patch artifacts. 2012-08-21 19:44:00 +02:00
R David Murray 07f6ea5506 #15742: clarify sqlite parameter substitution example. 2012-08-20 14:17:22 -04:00
R David Murray d928b6a965 #13579: minimize code base drift for 'a' string.Formatter change.
2.7 doesn't support 'a'.  This changeset ports the doc change
and clause-reording portions of Francisco Martín Brugué patch
in order to minimize code base drift.
2012-08-19 17:57:29 -04:00
Eli Bendersky 2cc49745a5 Fix typo in tutorial 2012-08-18 09:51:37 +03:00
Eli Bendersky 6ee2187cdc Issue #15586: porting ET's new documentation bits to 2.7. Patch by Daniel Ellis 2012-08-18 05:40:38 +03:00
R David Murray 85307b46d1 #15355: Mention already-executing Exception in generator docs.
Patch by Chris Jerdonek.
2012-08-17 20:49:51 -04:00
Terry Jan Reedy 73b19d0b00 Issue 15660: Clarify 0 prefix for width field in str.format doc. 2012-08-17 15:37:52 -04:00
Richard Oudkerk 3c3ab22d36 Issue #15412: Remove erroneous note about weakrefs 2012-08-17 15:00:58 +01:00
Sandro Tosi 4ffe9a0640 clarify in/not in in case of infinite iterators; thanks to Sergey Skovorodkin from docs@ 2012-08-15 21:37:19 +02:00
R David Murray c7b8f809e7 #15543: reflow paragraphs. 2012-08-15 11:22:58 -04:00
R David Murray 5618aaaafe #15543: glossary entry for and 'universal newlines', and links to it.
Patch by Chris Jerdonek.
2012-08-15 11:15:39 -04:00
R David Murray becfcc0a6b #15269: document dircmp.left and right.
Based on patch by Chris Jerdonek.
2012-08-14 21:50:38 -04:00
Sandro Tosi 6ce21a3b84 fix typo 2012-08-14 19:51:31 +02:00
Andrew Svetlov 6bcd00afa9 Issue #14167: Document return statement in finally blocks.
Patch by Yury Selivanov.
2012-08-14 15:44:53 +03:00
Andrew Svetlov 33f87a59b8 Issue #15497: Correct characters in TextWrapper.replace_whitespace docs.
Patch by Chris Jerdonek.
2012-08-13 23:26:28 +03:00
Senthil Kumaran 2f76f73d73 Issue #15630: Add an example for "continue" statement in the tutorial. Patch by
Daniel Ellis.
2012-08-12 11:58:53 -07:00
Sandro Tosi 614e44a0fa complete cgi.parse() signature; thanks to Aaron Bingham from docs@ 2012-08-12 18:47:45 +02:00
Sandro Tosi eca4006b1f add usage example from cli; thanks to Christian Clauss from docs@ 2012-08-12 17:33:41 +02:00
Sandro Tosi 106c25034a it's getstatus() not setstatus(); thanks to Shaddi Hasan from docs@ 2012-08-12 15:11:58 +02:00
Sandro Tosi 018e14dfe9 add missing quote in splitlines() example; thanks to Yevgen Yampolskiy from docs@ 2012-08-12 12:34:57 +02:00
Sandro Tosi 6c625e6024 update Geany URL; thanks to Karl Tarbet from docs@ 2012-08-12 11:01:50 +02:00
Sandro Tosi 682100e46a add missing parenthesis to 'action' argparse doc; thanks to kishkin from docs@ 2012-08-12 10:49:07 +02:00
Georg Brandl eb068f9fa1 Fix casing of SocketServer module in 2.7. 2012-08-11 11:12:55 +02:00
Andrew Svetlov 774c8a39dc fix docs for c-api memory functions 2012-08-09 21:32:11 +03:00
Andrew Svetlov 8afcec41f4 Issue #15501: Document exception classes in subprocess module.
Initial patch by Anton Barkovsky.
2012-08-09 15:23:49 +03:00
Benjamin Peterson 359b5032f6 make documented file() kw names and actual ones agree (closes #15572)
Patch by Daniel Ellis.
2012-08-07 11:57:47 -07:00
R David Murray decdb74227 #15554: clarify splitlines/split differences.
Patch by Chris Jerdonek.
2012-08-06 16:09:09 -04:00
Sandro Tosi 7687f3fb80 add missing period; thanks to Gaston Fiore from docs@ 2012-08-04 19:42:06 +02:00
Antoine Pitrou 76370f4977 Make TextIOWrapper's documentation clearer by copying the newline argument's description from open(). 2012-08-04 00:55:38 +02:00
Eli Bendersky 4c36aa4108 Issue #15231: update PyPI upload doc to say --no-raw passed to rst2html.py 2012-08-02 03:00:33 +03:00
Vinay Sajip 4f947dd970 Improved cookbook entry and fixed typo. 2012-07-27 10:52:18 +01:00
Andrew Svetlov 15fc22011d Issue #15041: Update "see also" list in tkinter documentation. 2012-07-26 17:19:40 +03:00
Antoine Pitrou b37f14c70e Mention the *limit* argument of TextIO.readline(). 2012-07-25 22:38:33 +02:00
Vinay Sajip 34e992d451 Issue #15445: Updated logging configuration documentation to highlight potential security risk posed by listen() in certain scenarios. 2012-07-25 19:12:35 +01:00
Jesus Cea 0f9b8ee21b Rollback an incorrect Doc/ACKS.txt entry 2012-07-23 18:39:51 +02:00
Jesus Cea fde7890f48 Better test for Issue #15402: Add a __sizeof__ method to struct.Struct 2012-07-23 18:14:45 +02:00
Senthil Kumaran 0c472c3271 Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch contributed by Chris Jerdonek. 2012-07-22 19:36:03 -07:00
Vinay Sajip bee739baa7 Issue #15399: Added versionchanged for processName. 2012-07-20 09:48:46 +01:00
R David Murray 59488d233b Closes #9254: backport __import__ docstring/doc mentions of importlib.
Patch by Éric Araujo.
2012-07-18 19:44:08 -04:00
R David Murray fc095202af #15375: remove duplicated word 'child' 2012-07-16 22:31:32 -04:00
Ezio Melotti e608e3141e #15345: fix SyntaxError in argparse tutorial example. Patch by Simon Hayward. 2012-07-13 21:40:25 +02:00
Terry Jan Reedy 45ed012433 Issue #13557: Clarify effect of giving two different namespaces to exec or
execfile().
2012-07-08 17:35:26 -04:00
Georg Brandl 5356af8c48 Fix leftover quote. 2012-07-06 21:36:48 +02:00
Éric Araujo 9e06e37be0 Branch merge 2012-07-03 01:13:40 -04:00
Éric Araujo 3cf202e957 Ignore .nfs* files in distutils (#7719).
These files are created by some NFS clients a file is edited and removed
concurrently (see added link in doc for more info).  If such a file is
removed between distutils calls listdir and copy, it will get confused.
Other special files are ignored in sdist (namely VCS directories), but
this has to be filtered out earlier.
2012-07-03 01:12:42 -04:00
Raymond Hettinger e16c882584 Make it easier to search for the grouper() recipe. 2012-07-02 21:08:45 -07:00
Éric Araujo 96534689a8 Use source role to get links to files 2012-07-02 17:46:56 -04:00
Éric Araujo 06176a89ff Adapt mentions of future changes in doc 2012-07-02 17:46:40 -04:00
Raymond Hettinger 2aa8519f07 The StopIteration API applies to both tokenize() and generate_tokens() 2012-07-01 20:00:09 -07:00
Georg Brandl e683ef55fc Make call of os.getppid() conditional: it is not available on Windows. 2012-07-01 09:47:54 +02:00
Georg Brandl 1014686d76 Remove an unneeded footnote. 2012-07-01 09:40:16 +02:00
Senthil Kumaran 9d5d507322 urlparse docs clean up 2012-06-28 21:07:32 -07:00
Antoine Pitrou d9a5137742 Issue #5067: improve some json error messages.
Patch by Serhiy Storchaka.
2012-06-29 01:58:26 +02:00
Senthil Kumaran 189bd91255 issue13666 - Fixing datetime documentation example when using tzinfo 2012-06-26 20:05:12 +08:00
Ezio Melotti f637920652 #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 5ec84cd69e Issue #14933: fix misleading doc about weakref support in extension types. 2012-06-15 19:11:31 +02:00
Sandro Tosi 771d98d694 Issue #15060: better fix, thanks to review on #python-dev 2012-06-14 00:36:54 +02:00
Sandro Tosi 89539e8268 Issue #15060: fix typo in socket doc; Patch by anatoly techtonik 2012-06-13 23:58:35 +02:00
Raymond Hettinger 491f7070f1 Code cleanups 2012-06-08 13:24:12 -07:00
R David Murray 1eda5c9a83 #8652: update errors tutorial.
The tutorial had some outdated examples.  The patch also adds a caution
about the meaning of parens in the except statement.

Patch by Marien Zwart.
2012-06-07 21:46:44 -04:00
Nick Coghlan 0a09f3e2c3 Nudge readers towards a more accurate mental model for loop else clauses (Backport from 3.x) 2012-06-07 22:57:35 +10:00
Sandro Tosi fd4c4b1e01 backport c4bd68be5fc6 to 2.7 2012-06-02 23:40:59 +02:00
Sandro Tosi 5fae78c09d refer to time.strftime 2012-06-02 18:21:06 +02:00
R David Murray de738a1b82 #14957: fix doc typo. 2012-06-02 11:21:31 -04:00
R David Murray 4fbf7c61fe #14957: clarify splitlines docs.
Initial patch by Michael Driscoll, I added the example.
2012-06-01 16:21:06 -04:00
R David Murray b42b6eba63 #11785: fix the :mod: references in email package submodule titles. 2012-05-27 17:13:54 -04:00
Hynek Schlawack d68ffdb45a Restore [] where default arguments are not keywords
Reverts some changes of a36666c52115.

In the case of os's `mknod(filename[, mode=0600[, device=0]])`, I have nested
the [] as setting mode doesn't require to set device (but setting device
requires to set mode).
2012-05-22 15:22:14 +02:00
Hynek Schlawack e58ce01f30 #14804: Remove [] around optional arguments with default values
Mostly just mechanical removal of []. In some rare cases I've pulled the
default value up into the argument list.
2012-05-22 10:27:40 +02:00
Vinay Sajip 5f045ea440 Fixes #14864: Added documentation on how to undo the effects of a logging.disable() call. 2012-05-20 15:35:00 +01:00
Hynek Schlawack 897b278cf0 Document when json.load's parse_constant behaviour changed
It doesn't get called on 'null', 'true', 'false' since f686aced02a3.
2012-05-20 11:50:41 +02:00
Petri Lehtinen 5f39706b07 #14494: Document that absolute imports became default in 3.0 instead of 2.7. 2012-05-19 18:36:04 +03:00
Petri Lehtinen 491ef97f75 Fix time.time() references in the time module docs
Closes #14842.
2012-05-18 21:19:18 +03:00
R David Murray 1bddab7f0c #14823: Simplify threading.Lock.acquire argument discussion. 2012-05-17 09:15:02 -04:00
Hynek Schlawack 019935f615 #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 18:02:54 +02:00
R David Murray e3d8ab6d38 #1440472: reflow 2012-05-15 22:12:56 -04:00
R David Murray af707234c6 #1440472: Explain that email parser/generator isn't *quite* "idempotent" 2012-05-15 22:12:09 -04:00
R David Murray 8349bc2ba9 #14766: Reflow the altered paragraphs. 2012-05-14 22:33:36 -04:00
R David Murray 089d4d4f7c #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:32:44 -04:00
Ezio Melotti ace9261558 #14405: remove outdated/broken/duplicate links. 2012-05-14 13:26:45 +03:00
Ezio Melotti e710c996ab #14770: backport a couple of changes from 3.x. 2012-05-13 20:19:41 +03:00
Ezio Melotti 6176db5aac #14770: improve the library FAQ. 2012-05-13 19:49:00 +03:00
Sandro Tosi 334be84540 correctly define what 'fill' could be; thanks to Leland Hulbert from docs@ 2012-05-12 23:29:06 +02:00
Raymond Hettinger 56f5c38320 Additional example of using decimal.localcontext(). 2012-05-11 12:50:11 -07:00
Ezio Melotti 35d03ed832 #14763: document default maxsplit value for str.split. 2012-05-10 15:30:42 +03:00
Ezio Melotti 95f42a86dd #14763: fix documentation for string.split/rsplit. 2012-05-09 14:59:24 +03:00
R David Murray 5ec0340ce1 Improve the grammar of a non-sentence. 2012-05-08 21:29:36 -04:00
Sandro Tosi 1d710b6a84 backport 7a05cb3beddf to 2.7 2012-05-07 21:56:24 +02:00
Georg Brandl c5288e60f3 Fix document title for Sphinx. 2012-05-06 21:39:35 +02:00
Ezio Melotti 1c96f946cf #14034: adapt to Python 2 and fix indentation. 2012-05-06 17:03:19 +03:00
Ezio Melotti e48daea2a6 #14034: added the argparse tutorial. Patch by Tshepang Lekhonkhobe. 2012-05-06 16:15:35 +03:00
Ezio Melotti 510ff54324 Use Python 3 instead of 3.0. 2012-05-03 19:21:40 +03:00
Ned Deily d811e150f5 Issue #10433: Document unique behavior of 'os.getgroups' on Mac OS X. 2012-04-30 11:13:16 -07:00
Ezio Melotti 30abb3a6a8 #14558: document the module, argv, and testLoader args of unittest.main. 2012-04-30 19:05:57 +03:00
Raymond Hettinger 524bc3993f Fix typo 2012-04-29 09:25:25 -07:00
Ezio Melotti 8950019283 #14519: fix the regex used in the scanf example. 2012-04-29 11:47:28 +03:00
Ezio Melotti 217e6a66db Fix markup in unittest doc. 2012-04-29 10:52:18 +03:00
Senthil Kumaran fb5aebc1cc Fix issue6085 - Remove the delay caused by fqdn lookup while logging in BaseHTTPRequestHandler 2012-04-29 13:39:16 +08:00
Ezio Melotti 1142773084 #14461: fix wording. 2012-04-29 07:34:22 +03:00
Senthil Kumaran 429d311c2b issue14427 - Document Request.get_header and Request.header_items 2012-04-29 11:52:59 +08:00
Ezio Melotti 48d886b725 #14155: add a note about \b. 2012-04-29 04:46:34 +03:00
Sandro Tosi f8ece8d777 refer to file.readline() in stdtypes doc; thanks to Mihai Capotă from docs@ 2012-04-28 12:50:42 +02:00
Sandro Tosi 2d0bcd7ca9 Issue #14676: DeprecationWarning is ignored too; patch by Peter Eisentraut 2012-04-28 12:20:57 +02:00
Sandro Tosi aa31d52b80 Issue #14448: add reference to IANA timezone database; thanks to Georg/Nick suggestions 2012-04-28 11:19:11 +02:00
Raymond Hettinger 9aa1395916 Make the example cut and pasteable. 2012-04-27 09:55:31 -07:00
Sandro Tosi 51a5ad43b5 fix footnote reference; thanks to Fizz from docs@ 2012-04-25 19:55:30 +02:00
Sandro Tosi 13c598b1d8 Issue #14448: mention pytz; patch by Andrew Svetlov 2012-04-24 19:43:33 +02:00
Sandro Tosi 466a5f20f1 Issue #14554: correct example for captured_stdout() 2012-04-24 18:38:59 +02:00
Sandro Tosi 3f0f5776cd Issue #13478: document timeit.default_timer() 2012-04-24 18:11:29 +02:00
Sandro Tosi 45c6a3cae7 Issue #13587: use the right RFC2617 name for WWW-Authenticate; patch by Aaron Maenpaa 2012-04-24 17:36:14 +02:00
Raymond Hettinger e65753e09e merge 2012-04-23 21:26:58 -07:00
Raymond Hettinger ce0e0c7671 Improve section heading for better discoverability. 2012-04-23 21:26:35 -07:00
Raymond Hettinger 4c8d392bc1 Reorder the entries to put the type specific technique last. 2012-04-23 21:24:15 -07:00
R David Murray 393b7b59a4 #14640: Fix typos/syntax in pyporting.rst.
Patch by Dionysios Kalofonos.
2012-04-23 14:46:39 -04:00
Sandro Tosi da999d29ab Issue #14641: minor fixes to sockets Howto; patch by Dionysios Kalofonos 2012-04-23 19:44:51 +02:00
Raymond Hettinger 016878aea6 merge 2012-04-23 00:22:48 -07:00
Senthil Kumaran ea17082c25 Update 2.7 docs about legal characters allowed in Cookie name 2012-04-22 10:27:22 +08:00
Ned Deily 9b5952d7cd Remove webbrowser doc reference to the previously removed internet-config option. 2012-04-18 12:48:09 -07:00
Raymond Hettinger 094c33f047 Minor fixups. 2012-04-18 00:25:32 -04:00
Raymond Hettinger 33c66301ee Clean-up the SQLite introduction. 2012-04-17 22:48:06 -04:00
Raymond Hettinger 0e15a6e244 Clarify that a new connection needs to be made after the close. 2012-04-17 15:03:20 -04:00
Vinay Sajip 8085f44844 Tweaked format of cookbook example. 2012-04-16 15:45:11 +01:00
Vinay Sajip 4e646aaf93 Added cookbook example for log insertion. 2012-04-16 15:27:55 +01:00
R David Murray 142ab32ecd #14552: remove redundant wording in 'test' docs.
Original patch by Tshepang Lekhonkhobe.
2012-04-11 20:38:45 -04:00
Senthil Kumaran dc0b324a0f Fix closes Issue14258 - Clarify the re.LOCALE and re.UNICODE flags for \S class 2012-04-11 03:22:58 +08:00
Vinay Sajip 2a1c13bb2d Updated logging reference and HOWTO. 2012-04-10 19:52:06 +01:00
Senthil Kumaran 3661473ae0 minor .rst fix 2012-04-10 19:50:08 +08:00
Sandro Tosi ceeb47d0c3 Issue #14502: release() and unlocked lock generates a ThreadError 2012-04-05 22:51:00 +02:00
Georg Brandl b45c5e2d0e Closes #14489: correct link target. 2012-04-05 09:04:40 +02:00
R David Murray 5fc56eb1ca #14481: fix formatting of example in subprocess docs. 2012-04-03 08:46:05 -04:00
Sandro Tosi d987c0221c fix typo; thanks to Robert Bardos from docs@ 2012-04-01 01:49:46 +02:00
Sandro Tosi 6ca845c66a use unittest.skip; thanks to Chang Min Jeon from docs@ 2012-03-31 18:34:42 +02:00
Sandro Tosi 04cd09552a add 'safari' to webbrowser browsers table; thanks to Jonathan Eunice from docs@ 2012-03-31 17:22:47 +02:00
R David Murray 5080cad646 #10423: clarify options vs args in argparse discussion of optparse
Patch by Sandro Tosi.
2012-03-30 18:09:07 -04:00
R David Murray de294ec02e #14416: add missing LOG_SYSLOG facility to syslog docs. 2012-03-29 06:47:59 -04:00
Sandro Tosi 48a88953cc Issue #14410: fix typo in argparse doc; patch by Tshepang Lekhonkhobe 2012-03-26 19:35:52 +02:00
Vinay Sajip 49d5fbab87 Minor documentation tweak. 2012-03-26 17:06:44 +01:00
Georg Brandl 99c1f594b3 Closes #14401: fix typos in curses howto. 2012-03-25 08:43:22 +02:00
Martin v. Löwis fcf37c1896 Issue #14400: Fix typo. 2012-03-24 17:38:29 +01:00
Georg Brandl 94a105705f Closes #14250: regex.flags has not only explicit flags but also those from the pattern 2012-03-17 17:31:32 +01:00