Commit Graph

12030 Commits

Author SHA1 Message Date
Georg Brandl 557a3ec9bb Closes #14343: avoid shadowing builtin input() in example code. 2012-03-17 17:26:27 +01:00
Georg Brandl 5ec6fdb0f6 Closes #14342: remove out-of-date section about avoiding recursion errors. 2012-03-17 17:25:47 +01:00
Georg Brandl 12c3cd7c1f Closes #14306: clarify expensiveness of try-except and update code snippet 2012-03-17 16:58:05 +01:00
Senthil Kumaran f2123d2db5 3.2 explain json.dumps for non-string keys in dicts. closes issue6566. Patch contributed Kirubakaran Athmanathan 2012-03-17 00:40:34 -07:00
R David Murray 41914349ad #11780: s/throw/raise/ 2012-03-16 22:10:00 -04:00
R David Murray 69ebfe43b0 #11780: document that email.encoders throw TypeError on multipart messages. 2012-03-16 22:03:17 -04:00
Eli Bendersky 969b8daf5a Issue #14202: some additional doc fixes 2012-03-16 16:49:58 +02:00
Eli Bendersky 3fb05a90ce Issue #14202: Greatly enhance the documentation of xml.dom.pulldom.
Patch by Florian Mladitsch
2012-03-16 14:37:14 +02:00
Eli Bendersky 604c4ff43d Issue #9257: clarify the events iterparse accepts 2012-03-16 08:41:30 +02:00
Senthil Kumaran 6b3434ae04 Explain the use of charset parameter with Content-Type header. Issue11082 2012-03-15 18:11:16 -07:00
R David Murray 38c2754652 #12758: removing confusing mention of UTC from time.time description
Patch by Dylan Sarber.
2012-03-15 03:06:15 -04:00
Senthil Kumaran 87684e6eea Fix the wrong urllib exampls which use str for POST data. Closes Issue11261 2012-03-14 18:08:13 -07:00
Georg Brandl 300a691026 Closes #14305: fix typo. 2012-03-14 22:40:08 +01:00
Georg Brandl 525fd5447d Closes #14289: put a link to the CHM download page on the docs download page. 2012-03-14 08:18:47 +01:00
Georg Brandl 69c7a69cbe Closes #14283: match() and search() are regex methods, not match methods. 2012-03-14 08:02:43 +01:00
Senthil Kumaran 21c71bac5f closes Issue12365 - Add an example explaining the context manager use case of urllib.urlopen 2012-03-13 19:47:51 -07:00
Senthil Kumaran 6080db7606 closes issue14257 - Grammatical fix 2012-03-12 10:05:34 -07:00
Senthil Kumaran a7fccd8b14 closes issue14257 - 3.2 minor error in glossary wording regarding __hash__ 2012-03-11 21:04:56 -07:00
Mark Dickinson 328dd0d5f3 Closes #9574: Note that complex constructor doesn't allow whitespace around central operator. 2012-03-10 16:09:35 +00:00
Georg Brandl 64a40949cf Closes #14186: add link to PEP 3107 (function annotations) to the function definition section. 2012-03-10 09:22:47 +01:00
Senthil Kumaran 065dedaf47 Fix closes Issue: 14217 - 3.2 branch 2012-03-08 20:56:52 -08:00
Jason R. Coombs 30b8e5461d Use PEP-8 style in logging example 2012-03-07 10:26:08 -05:00
Éric Araujo e5eec7e198 Move xml.etree higher and xml.parsers.expat lower in the markup ToC.
I assume that most users looking at this page are looking for a library
to process XML, not a low-level parser.  First proposed in #11379.
2012-03-05 16:01:41 +01:00
Éric Araujo fdfaf0aba2 Use source reST role instead of file where it makes sense.
source generates a nifty link to the Mercurial web viewer.
2012-03-05 15:50:37 +01:00
Éric Araujo d3899e320f Remove mention of defunct file.
Misc/COPYRIGHT was renamed twelve years ago to LICENSE and later copied
to the main docs, to which there is already a link.
2012-03-05 15:47:32 +01:00
Eli Bendersky b2b18632ce merge 3.2 heads 2012-03-02 07:43:08 +02:00
Eli Bendersky 20293441da Issue #11379: add a note in xml.dom.minidom suggesting to use etree in some cases 2012-03-02 07:37:13 +02:00
Petri Lehtinen 4d2bfb5e08 sqlite3: Port documentation changes from the 2.7 branch
Issue #13491.
2012-03-01 21:48:38 +02:00
Ezio Melotti 443f000bdd #14155: remove duplication about search vs match in re doc. 2012-02-29 13:39:05 +02:00
Ezio Melotti 5a045b9f54 #10713: Improve documentation for \b and \B and add a few tests. Initial patch and tests by Martin Pool. 2012-02-29 11:48:44 +02:00
Larry Hastings 62417a0354 Propagate changes for issues #13053 and #13086 from 2.7 to 3.2. (Doc only.) 2012-02-28 16:21:47 -08:00
Sandro Tosi 83c48822c5 s/div/truediv/; thanks to Félix-Antoine Fortin from docs@ 2012-02-28 22:28:28 +01:00
Vinay Sajip 39b83ac772 Improved logging cookbook example. 2012-02-28 08:05:23 +00:00
Georg Brandl e998386442 Fix markup errors. 2012-02-28 08:21:40 +01:00
Vinay Sajip 982f534fab Updated cookbook with information on customising LogRecords. 2012-02-27 11:56:29 +00:00
Vinay Sajip 6b883a2c4d Updated logging cookbook with info on alternative format styles. 2012-02-27 11:02:45 +00:00
Gregory P. Smith 3bbdc8e822 Issue #14123: Explicitly mention that old style % string formatting has caveats
but is not going away any time soon.
2012-02-26 01:54:07 -08:00
Éric Araujo f527277b67 Branch merge 2012-02-26 04:00:43 +01:00
Éric Araujo a6091998af Use const markup instead of a misleading string literal 2012-02-26 02:13:30 +01:00
Ezio Melotti 4342722f40 #14114: don't include copybutton.js in the htmlhelp output. 2012-02-25 19:24:24 +02:00
Georg Brandl e578021696 Add 3.2.3 to license. 2012-02-23 21:19:18 +01:00
Georg Brandl eb25fb7af7 Fix markup errors. 2012-02-23 21:12:39 +01:00
Georg Brandl 7ef825fdab merge with 3.2 2012-02-21 22:36:37 +01:00
Georg Brandl c9a42070a6 Remove reST markup from --help output. Also: O(n**2) is dict construction, not single insertion. 2012-02-21 22:36:27 +01:00
Georg Brandl 09a7c72cad Merge from 3.1: Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
in order to make algorithmic complexity attacks on (e.g.) web apps much more complicated.

The environment variable PYTHONHASHSEED and the new command line flag -R control this
behavior.
2012-02-20 21:31:46 +01:00
Georg Brandl 2daf6ae249 Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
in order to make algorithmic complexity attacks on (e.g.) web apps much more complicated.

The environment variable PYTHONHASHSEED and the new command line flag -R control this
behavior.
2012-02-20 19:54:16 +01:00
Vinay Sajip fee358b0df logging: clarified documentation for Handler.handleError. 2012-02-20 18:35:26 +00:00
Éric Araujo c3ef037ee1 Add missing “::” markup.
Also wrap two looong lines.
2012-02-20 01:44:55 +01:00
Sandro Tosi 0467686e07 Issue #13605: use print() in argparse nargs example 2012-02-19 19:54:00 +01:00
Sandro Tosi f06d444f5a don't split 'Hye-Shik Chang' name; thanks to Sergey from docs@ 2012-02-19 12:30:28 +01:00
Sandro Tosi 76dea27421 Indent 'File' in memoryview example, so it is correctly highlighted 2012-02-19 12:28:01 +01:00
Sandro Tosi c33ae06cbf fix error in memoryview example; thanks to kan lianlian from docs@ 2012-02-18 16:05:34 +01:00
Terry Jan Reedy ead1de2f03 Issue 14023 Revert edit to 2.7 version. (I suspect edit is from when we thought
to to makes bytes mutable, before deciding to add bytearrays.)
2012-02-17 19:56:58 -05:00
Ezio Melotti 4279bc7aef #14020: improve HTMLParser documentation. 2012-02-18 02:01:36 +02:00
Petri Lehtinen b3890226b3 sqlite3: Fix documentation errors concerning Cursor.rowcount
Closes #13995.
2012-02-16 21:39:03 +02:00
Sandro Tosi 5cb522cb32 Issue #11836: document multiprocessing.queues.SimpleQueue 2012-02-15 23:14:21 +01:00
Petri Lehtinen 1ca93954e1 Issue #13491: Fix many errors in sqlite3 documentation
Initial patch by Johannes Vogel.
2012-02-15 22:21:01 +02:00
Éric Araujo ccddc474c3 Improve doc for atexit.register and unregister (#12297) 2012-02-15 17:07:49 +01:00
Senthil Kumaran 7f728c1e1a shutil copy module reference doc fix. 2012-02-13 23:30:47 +08:00
Gregory P. Smith 58f23ffb21 Issue #13930: Adds ability for 2to3 to write its output to a different
directory tree instead of overwriting the input files.  Adds three command
line options: -o/--output-dir, -W/--write-unchanged-files and --add-suffix.

Feature backports into stable release branches for 2to3 are allowed by
a special exemption:
 http://mail.python.org/pipermail/python-dev/2011-December/115089.html
2012-02-12 15:50:21 -08:00
Éric Araujo 01a2215727 Update mention of Subversion in the FAQ.
If I grepped correctly, this was the last outdated place.
2012-02-12 04:49:45 +01:00
Nadeem Vawda 30d94b7aea Issue #13989: Document that GzipFile does not support text mode.
Also, give a more helpful error message when opened with an invalid mode string.
2012-02-11 23:45:10 +02:00
Senthil Kumaran 5b14d732d8 Issue #9021 - Introduce copy module better. Doc changes suggested by Terry
Reedy.
2012-02-09 18:26:59 +08:00
Senthil Kumaran 6e13f130a9 Fix Issue #6005: Examples in the socket library documentation use sendall,
where relevant, instead send method.
2012-02-09 17:54:17 +08:00
Éric Araujo cd2a6033ac Branch merge 2012-02-05 13:41:47 +01:00
Nadeem Vawda bd249c1bae Clarify note in BZ2File docs about lack of multi-stream support (issue #1625). 2012-02-05 14:29:00 +02:00
Georg Brandl 9701eb6e14 Closes #13944: fix capitalization of class name. 2012-02-05 09:25:22 +01:00
Nadeem Vawda 8f50912f87 Issue #1625: Document BZ2File's lack of support for multi-stream inputs. 2012-02-04 23:44:49 +02:00
Benjamin Peterson f51ebf94bb threading primitives now have timeouts 2012-02-04 09:55:52 -05:00
Petri Lehtinen 9713321f46 Document absoluteness of sys.executable
Closes #13402.
2012-02-02 20:59:50 +02:00
Brian Curtin 090ec3c7fc merge. again. 2012-02-01 15:24:10 -06:00
Brian Curtin 10dda6e029 Add a hint that CSD == Service Pack.
People searcing for the way to get a "service pack" will never find that we
provide it here, and people that find this function won't know what CSD is
until they run the function. On top of this, they won't know what the value
means unless they really have a service pack installed.

CSD, or Customer Service Diagnostics, is apparently no longer used, and was
rarely used term at that. Most references to it online are from
universities making Windows 2000 and XP service packs available to students.
2012-02-01 15:14:00 -06:00
Raymond Hettinger fc3ba6b8fc Add usage note 2012-02-01 09:07:40 -08:00
Georg Brandl c875d2032b Fix #13900: resolve self-referential description of a parameter. 2012-01-29 15:38:47 +01:00
Benjamin Peterson 871b9d169d note that get() is not affected by default_factory (closes #13887) 2012-01-27 09:14:01 -05:00
Antoine Pitrou 04707c032e Fix error handling in examples of C API use. 2012-01-27 14:07:29 +01:00
Antoine Pitrou 9f6b02ecde Clarify that ssl.OP_ALL can be different from OpenSSL's SSL_OP_ALL. 2012-01-27 10:02:55 +01:00
Brett Cannon 722db7bdba merge 2012-01-26 18:36:08 -05:00
Brett Cannon 1740afded1 Issue #13883: Document all platforms PYTHONCASEOK works on. 2012-01-26 18:29:06 -05:00
Meador Inge 65992c1c01 - Issue #13840: Fix ctypes.create_string_buffer exception message and docs. 2012-01-26 08:44:00 -06:00
Georg Brandl 6c89a79d55 #13852: some small doc fixes. 2012-01-25 22:36:25 +01:00
Benjamin Peterson b4b0b354dd kill extra word 2012-01-25 16:30:18 -05:00
Benjamin Peterson e9fca253d0 say bitwise (because I have no idea what a bit-string is) 2012-01-25 16:29:03 -05:00
Antoine Pitrou 5311c1d7ab Issue #13772: In os.symlink() under Windows, do not try to guess the link
target's type (file or directory).  The detection was buggy and made the
call non-atomic (therefore prone to race conditions).
2012-01-24 08:59:28 +01:00
Georg Brandl 3b65fd7e97 #13816: fix two minor style issues. Thanks to Justin Wehnes for the patch. 2012-01-23 20:19:33 +01:00
Antoine Pitrou f49d152ab2 Issue #12922: fix the TextIOBase documentation to include a description of seek() and tell() methods. 2012-01-21 20:20:49 +01:00
Sandro Tosi 41b2404dab fix typo; thanks to Justin Watt from docs@ 2012-01-21 10:59:37 +01:00
Meador Inge a3443d985e Issue #12949: Document the kwonlyargcount argument for the PyCode_New C API function. 2012-01-19 22:06:31 -06:00
Sandro Tosi da8e11ac71 Issue #13605: more meaningful example + fixes 2012-01-19 22:23:00 +01:00
Sandro Tosi 16bd0b4463 Issue #13605: add documentation for nargs=argparse.REMAINDER 2012-01-19 21:59:55 +01:00
Sandro Tosi f0229aa51c Issue #11948: clarify modules search path 2012-01-19 11:29:26 +01:00
Meador Inge 972cfb9169 Issue #2134: Clarify token.OP handling rationale in tokenize documentation. 2012-01-19 00:22:22 -06:00
Georg Brandl c77bb65deb Remove "documenting" latex document. 2012-01-16 21:40:12 +01:00
Sandro Tosi 32ee44ffb4 Issue: #12409: remove obsolete susp-entries 2012-01-16 18:02:09 +01:00
Éric Araujo f2fbb9cf42 Improve interlinking of archiving/compression modules docs.
- Remove duplicated list of links to the other modules from each
  module’s doc (people can already go up to library/archiving and
  there they can see the list).

- Link to shutil high-level operations.

Reviewed by Nadeem Vawda in #6715.
2012-01-16 16:55:55 +01:00
Éric Araujo 6f7aa00c1e Document json.dump ensure_ascii parameter (#13770) 2012-01-16 10:09:20 +01:00
Ezio Melotti 01b34afb3a #13715: fix typo in unicodedata doc. Patch by Eli Collins. 2012-01-16 08:42:32 +02:00
Ezio Melotti 9ecb6beb8c #13695: fix a couple of typos in the doc. 2012-01-16 08:28:54 +02:00
Éric Araujo 9c7b9190c3 Markup improvements for the embedding CPython doc patch from #1040439 2012-01-15 02:31:58 +01:00
Éric Araujo 9cff42736d Hide or remove user-visible XXX notes from distutils doc (#13716).
Requested by Florent Xicluna with the rationale that they make the docs
look unfinished.  I’ve also removed a few XXX notes that were not
visible in the HTML but could waste contributors’ time by suggesting
improvements that are never going to happen for distutils.
2012-01-15 02:25:31 +01:00
Sandro Tosi 515687a7ed remove 'Documenting Python' and its references, it's now on devguide 2012-01-14 22:23:27 +01:00
Gregory P. Smith c1f079f317 Mention the additional way to use the lvl parameter and when it changed. 2012-01-14 12:46:17 -08:00
Terry Jan Reedy a931463fea #13730 grammar fix 2012-01-13 23:43:13 -05:00
Terry Jan Reedy a3d1e2e342 #11633 At least 2 people prefer earlier revision. 2012-01-12 14:49:02 -05:00
Antoine Pitrou 889a5101c2 Issue #13724: improve documentation for socket.create_connection. 2012-01-12 08:06:19 +01:00
Terry Jan Reedy ea868d32a1 Minor correction. #11418 2012-01-11 14:54:34 -05:00
Terry Jan Reedy e247928fed Closes #11633 Clarify print buffering. 2012-01-11 14:09:49 -05:00
Terry Jan Reedy f4ec3c5a92 #13754 String returned if less than *or equal to* x 3
Close *13753 'seq' now 'iterable'
2012-01-11 03:29:42 -05:00
Senthil Kumaran 19d85c2762 Issue9637 - Explain in getproxies_environment that <scheme>_proxy environ variable case does not matter. 2012-01-11 01:29:08 +08:00
Antoine Pitrou ac8bfcacfc Issue #13747: fix SSL compatibility table. 2012-01-09 21:43:18 +01:00
Antoine Pitrou 84a2edcdf7 Issue #13747: fix documentation error about the default SSL version. 2012-01-09 21:35:11 +01:00
Sandro Tosi 645a0dd6f7 Py_SetPythonHome() can be called before Py_Initialize(); thanks to Cody Smith from docs@ 2012-01-07 18:34:07 +01:00
Charles-François Natali ded0348c08 Issue #13502: threading: Fix a race condition in Event.wait() that made it
return False when the event was set and cleared right after.
2012-01-07 18:24:56 +01:00
Sandro Tosi b52e7a9a36 clarify recv* are blocking operations; thanks to Chris Kogelnik from docs@ 2012-01-07 17:56:58 +01:00
Antoine Pitrou 441ae043df Update printout of SSL certificate examples for 3.2+. 2012-01-06 20:06:15 +01:00
Sandro Tosi f57674713a Issue #12042: a queue is only used to retrive results; preliminary patch by Jordan Stadler 2012-01-05 19:48:56 +01:00
Sandro Tosi ba232dfc83 Issue #11984: remove reference to parser, it's not showing symbol usage anymore 2012-01-05 19:06:25 +01:00
Sandro Tosi 98492a50ea Issue #10772: add count and help argparse action; patch by Marc Sibson 2012-01-04 23:25:04 +01:00
Antoine Pitrou b7ffed8a50 Add a subsection explaning cipher selection. 2012-01-04 02:53:44 +01:00
Benjamin Peterson d204934ee3 exception support is correct now (closes #13705) 2012-01-03 16:30:37 -06:00
Sandro Tosi 753b79c073 Issue #6031: improve serve_forever() description 2012-01-03 22:35:54 +01:00
Sandro Tosi ea320abcae Issue #9349: add argparse.SUPPRESS to help doc 2012-01-03 18:37:03 +01:00
Sandro Tosi da785fd527 Issue #13690: add re.DEBUG; patch by Filip Gruszczyński 2012-01-01 12:55:20 +01:00
Sandro Tosi b2794c842f Issue #13683: raise with no exception in scope throws a RuntimeError; fix by Ramchandra Apte 2012-01-01 12:17:15 +01:00
Benjamin Peterson c40d362a1c merge heads 2011-12-31 22:42:45 -06:00
Benjamin Peterson f606e682a4 add another year to glorious PSF IP 2011-12-31 22:42:26 -06:00
Sandro Tosi 1abde3628b fix some broken URLs 2011-12-31 18:46:50 +01:00
Eli Bendersky d08effe287 Some formatting & grammar fixes for the multiprocessing doc 2011-12-31 07:20:26 +02:00
Benjamin Peterson a6c4a10d4e indicate msg is an argument 2011-12-30 23:08:09 -06:00
Benjamin Peterson 79ed84c7f2 use booleans 2011-12-30 13:47:25 -06:00
Georg Brandl 1532c8f9a7 I do not think we will ever have auto-indent at the prompt, that is for IPython and the like. 2011-12-25 19:03:07 +01:00
Sandro Tosi 7386662699 use list() to wrap range() in itertools.permutations() example; thanks to Romain MORLEVAT from docs@ 2011-12-25 17:25:45 +01:00
Sandro Tosi 3e6c814b9d fix "Title underline too short" sphinx warning 2011-12-25 17:14:11 +01:00
Sandro Tosi 2b373b0146 use double-quote char instead of unicode ones; thanks to tomo cocoa from docs@ 2011-12-25 17:07:22 +01:00
Sandro Tosi 44f568c21f fix to sent/send typo 2011-12-25 11:44:38 +01:00
Sandro Tosi 1526ad166e fix Constuctor/Constructor typo; thanks to Anthon van der Neut from docs@ 2011-12-25 11:27:37 +01:00
Sandro Tosi 3721fbc5de point IronPython to ironpython.net; thanks to Lazar Pancic from docs@ 2011-12-24 23:13:19 +01:00
Sandro Tosi 75c71ccf2a fix Rather that/Rather than; thanks to Reuben Thomas from docs@ 2011-12-24 19:56:04 +01:00
Sandro Tosi baf30da240 remove spurious dot from string formatting example; thanks to Anthon van der Neut from docs@ 2011-12-24 15:53:35 +01:00
Sandro Tosi 0b7e5369f1 correct syslog.openlog() argument name to logoption; thanks to Arnaud Gomes-do-Vale from docs@ 2011-12-24 14:51:49 +01:00
Meador Inge ac007ba686 Issue #13632: Update token documentation to reflect actual token types 2011-12-23 22:30:16 -06:00
Benjamin Peterson 57f97f400b parameter_list was meant here 2011-12-23 20:01:43 -06:00
Benjamin Peterson ad17358a2f kill superfluous 'comprehension' case (closes #13658) 2011-12-23 20:00:56 -06:00
Senthil Kumaran 016c6d5341 Issue12798 - Update mimetypes documentation. Correct the doc section where
common_types was mentioned under MimeTypes class, move it to helper function
category and other documentation improvements contributed by Sandro Tosi.
2011-12-23 10:52:42 +08:00
Antoine Pitrou 08c08eb93c Issue #13597: Fix the documentation of the "-u" command-line option, and wording of "What's new in Python 3.0" about standard streams. 2011-12-21 11:24:15 +01:00
Benjamin Peterson 0f1e3ac897 note the blinding speed of these functions 2011-12-20 10:12:41 -06:00
Benjamin Peterson 1c92cfea4a don't mention implementation detail 2011-12-19 16:41:11 -05:00
Ezio Melotti 80a61e8d4c #13387: rephrase unclear sentence. 2011-12-19 07:04:48 +02:00
Victor Stinner 6fbd525ef5 Issue #13617: Document that the result of the conversion of a Unicode object to
wchar*, Py_UNICODE* and bytes may contain embedded null characters/bytes.

Patch written by Arnaud Calmettes.
2011-12-18 19:22:31 +01:00
Victor Stinner a94a0e92b8 Issue #13522: Fix _Py_co_pow() documentation
Patch written by Arnaud Calmettes.
2011-12-18 02:56:18 +01:00