Commit Graph

11946 Commits

Author SHA1 Message Date
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
Antoine Pitrou 07b1c877b2 Issue #13522: document error return values of some float and complex C API functions. 2011-12-18 01:25:27 +01:00
Victor Stinner e83f899364 Issue #13530: Document os.lseek() result
Patch written by Jérémy Anger.
2011-12-17 23:15:09 +01:00
Ezio Melotti e5b2ac8987 #13613: fix example in re doc. 2011-12-17 01:17:17 +02:00
Antoine Pitrou 7158e06212 Issue #13597: Improve documentation of standard streams. 2011-12-15 16:25:34 +01:00
Ezio Melotti 7b7e39a61f #6570: clarify tutorial section about keyword arguments. 2011-12-13 15:49:22 +02:00
Ezio Melotti 91621e2c16 #13549: improve tutorial section about listcomps. 2011-12-13 15:36:19 +02:00
Lars Gustäbel 0c6cbbd632 Fix doc typo. 2011-12-10 12:45:45 +01:00
Antoine Pitrou 432259feea Issue #13528: rework the performance question in the programming FAQ 2011-12-09 23:10:31 +01:00
Antoine Pitrou 5b73ca4b3d s/SOCKSTREAM/TCP/ 2011-12-05 01:46:35 +01:00
Antoine Pitrou 8e644f0e7c Reword IPC section 2011-12-05 01:43:32 +01:00
Antoine Pitrou 8345451170 Use www.python.org instead of a hostname pointing to a parked (or squatted) domain.
Also, reformat a bit.
2011-12-05 01:37:34 +01:00
Antoine Pitrou fa03f6c863 Remove the outdated notion that multithreading doesn't work well on Unices. 2011-12-05 01:32:29 +01:00
Antoine Pitrou 534e253cb6 Remove reference to the base64 encoding. 2011-12-05 01:21:46 +01:00
Antoine Pitrou 48a7cbf7c2 The functional module hasn't been maintained since 2006 and doesn't work with Python 3.
Remove section about it from the functional programming FAQ.
2011-12-05 01:05:32 +01:00
Antoine Pitrou ae44b7a099 Remove obsolete references to bsddb 2011-12-05 00:41:19 +01:00
Antoine Pitrou c1bd4896cf Issue #13527: remove mention of Python megawidgets and Tkinter3000 WCK
from the doc. These two projects appear dead.
2011-12-04 23:56:30 +01:00
Georg Brandl 6a96a2e1f8 Fix typo. 2011-12-04 11:51:21 +01:00
Antoine Pitrou dec0f21efc Streamline mention of sorted() 2011-12-03 23:08:57 +01:00
Antoine Pitrou c561a9adac Break down and refine memory management question 2011-12-03 23:06:50 +01:00
Antoine Pitrou 17bd792cd3 Reformulate answer, and remove off-topic discussion of bytecode in a question about compiling to C. 2011-12-03 22:56:02 +01:00
Antoine Pitrou cc809a286a Fix compatibility statement. 2011-12-03 22:39:13 +01:00
Antoine Pitrou 748799a0a6 Remove outdated question (the bsddb module isn't included anymore) 2011-12-03 22:37:14 +01:00
Antoine Pitrou d4ddec5988 Refine FAQ entry for catching stdout 2011-12-03 22:35:31 +01:00
Antoine Pitrou 48383bfc67 Advocate PyTuple_Pack instead of manual building of tuples 2011-12-03 22:30:19 +01:00
Antoine Pitrou f35204055e Remove outdate FAQ content 2011-12-03 22:19:55 +01:00
Antoine Pitrou c5b266efb5 Streamline FAQ entry about the ternary operator, and suggest using io.StringIO for a mutable unicode container. 2011-12-03 22:11:11 +01:00
Antoine Pitrou 9cb41dfbaa Remove references to psyco, which is mostly unmaintained and doesn't work with Python 3. 2011-12-03 21:21:36 +01:00
Antoine Pitrou 5dd95d6f2d Mention PySide in the "other GUIs" page. 2011-12-03 21:07:01 +01:00
Antoine Pitrou 7462e87134 Mention the new GTK+ 3 bindings. 2011-12-03 20:59:24 +01:00
Meador Inge 777bebb0ef Issue #13513: IOBase docs incorrectly link to the readline module 2011-12-03 12:29:54 -06:00
Jason R. Coombs a90e364ea5 Issue #12666: Added section about map changes. 2011-12-03 08:24:21 -05:00
Jason R. Coombs df9a5f5ecf Issue #12666: Clarifying changes in map for Python 3 2011-08-01 17:51:34 -04:00
Ezio Melotti c1f26f6fc1 #13494: s/cast/convert/. Also add a link. 2011-12-02 19:47:24 +02:00
Ezio Melotti b1b3fd23b7 #13499: fix example adding >>> before the comments. 2011-12-02 19:28:36 +02:00
Antoine Pitrou 71bca3495d Issue #1040439: better document how to compile and link an embedded Python interpreter.
Still lacks docs for Windows (anyone?).
2011-11-30 21:19:21 +01:00
Éric Araujo c4d7d8c49d Mark up constants in sockets docs as such 2011-11-29 16:46:38 +01:00
Éric Araujo 2bddc53cb9 Fix typo (#13467) 2011-11-29 16:34:58 +01:00
Antoine Pitrou fd9ebd4a36 Clarify concatenation behaviour of immutable strings, and remove explicit
mention of the CPython optimization hack.
2011-11-25 16:33:53 +01:00
Eli Bendersky 5a53f368e6 fix some typos in Doc/c-api/memoryview.rst 2011-11-25 15:07:50 +02:00
Vinay Sajip 631a7e23c5 Added a configuration dictionary example to the logging cookbook. 2011-11-23 14:27:54 +00:00
Vinay Sajip 287f24691d Closes #13459: Clarified documentation on Logger.propagate. Thanks to Mike Fogel for the patch. 2011-11-23 08:54:22 +00:00
Amaury Forgeot d'Arc 3b1acf11e9 bytes() can't be used to get a representation of an object. 2011-11-22 19:34:08 +01:00
Mark Dickinson b1e58fe43f Issue #12245: Document sys.float_info.rounds better. 2011-11-19 16:26:45 +00:00
Ezio Melotti fabf0275a9 #13387: add note about checking the exact type in assertIsInstance doc. 2011-11-18 18:59:36 +02:00
Ezio Melotti e62aad3073 #13426: fix typos in pickle doc. 2011-11-18 13:51:10 +02:00
Eli Bendersky eeae1498aa fixing typos in optparse doc 2011-11-16 06:02:21 +02:00
Éric Araujo 04e6909845 Fix markup 2011-11-14 18:00:48 +01:00
Eli Bendersky d44af82e62 Issue #12767: documenting threading.Condition.notify 2011-11-12 20:44:25 +02:00
Florent Xicluna 599d76b275 Reformat paragraphs. 2011-11-11 19:56:26 +01:00
Florent Xicluna 45c6c3eb71 Few typos in the documentation. 2011-11-11 19:55:21 +01:00
Eli Bendersky a7795dbe9a Issue #13191: typo in argparse docs 2011-11-11 10:57:01 +02:00
Eli Bendersky c2c896093b Issue #13365: correct an error in the documentation of str.expandtabs 2011-11-11 10:40:14 +02:00
Nick Coghlan 32e4a58c06 Issue #13237: Fix formatting error - the legacy shell commands weren't meant to be under the Notes heading 2011-11-08 21:50:58 +10:00
Nick Coghlan 69ce0d8602 Issue #13237: Remove duplicate data value descriptions from the subprocess docs 2011-11-08 21:39:07 +10:00
Nick Coghlan c29248f232 Issue #13237: Forward port subprocess module updates and explicitly document UTF-8 encoding assumption when universal_newlines=True 2011-11-08 20:49:23 +10:00
Éric Araujo 06c42a3fca Document that shutil.make_archive does not typecheck its logger argument 2011-11-07 17:31:07 +01:00
Petri Lehtinen 395ca72380 Issue #3067: Enhance the documentation and docstring of locale.setlocale() 2011-11-05 10:21:16 +02:00
Éric Araujo 9c2f42f253 Branch merge 2011-11-03 16:27:57 +01:00
Éric Araujo a083823a85 Avoid relying on the default reST role in logging library doc 2011-11-03 04:35:20 +01:00
Éric Araujo 3bb1a6f990 State explicitely that PYTHONDONTWRITEBYTECODE is equivalent to -B 2011-11-03 03:20:43 +01:00
Victor Stinner 2662133a05 Issue #10570: curses.tigetstr() is now expecting a byte string, instead of a
Unicode string.

This is an incompatible change, but the previous behaviour was completly wrong.
2011-11-02 23:45:29 +01:00
Ezio Melotti 7de56f6a04 #670664: Fix HTMLParser to correctly handle the content of ``<script>...</script>`` and ``<style>...</style>``. 2011-11-01 14:12:22 +02:00
Sandro Tosi 4bfe03a42e correct signature for tzinfo.dst() in examples; thanks to Daniil Shved from docs@ 2011-11-01 10:32:05 +01:00
Sandro Tosi 53bcd66012 use diveintopython.net now that DIP.org returns 410; thanks to Josh Gachnang from docs@ 2011-10-31 17:46:04 +01:00
Sandro Tosi 69e59a17dd remove confusing paragraph (as part of r87523); thanks to AJ Hill from docs@ 2011-10-31 17:15:39 +01:00
Sandro Tosi e348455f5f document turtle done() function; thanks to Csaba Szepesvari from docs@ 2011-10-31 10:12:43 +01:00
Sandro Tosi 567493fe26 caught is the right pp of catch; thanks to Don Bennett from docs@ 2011-10-31 02:41:06 +01:00
Raymond Hettinger 6f45d18c24 Improve itertools docs with clearer examples of pure python equivalent code. 2011-10-30 15:06:14 -07:00
Ezio Melotti f54f6f520d Add a button to the code examples in the doc to show/hide the prompts and output. 2011-10-30 09:20:19 +02:00
Florent Xicluna 305bb662a9 Documentation typo 2011-10-28 22:14:41 +02:00
Florent Xicluna 83386dac8b I should be someone 2011-10-28 22:03:55 +02:00
Ezio Melotti f99e4b5dbe Improve HTMLParser example in the doc and fix a couple minor things. 2011-10-28 14:34:56 +03:00
Ezio Melotti 0b85cd0680 Merge heads. 2011-10-28 12:32:53 +03:00
Ezio Melotti d3cf0db3ee #13278: fix typo. 2011-10-28 12:22:25 +03:00
Florent Xicluna 74e6495a20 Fixes #13270: obsolete reference to old-style/new-style classes. 2011-10-28 11:21:19 +02:00
Vinay Sajip 6187664fa7 Added lost documentation cross-reference. 2011-10-27 17:50:55 +01:00
Ezio Melotti fbb39815d4 Refactor a bit the codecs doc. 2011-10-25 10:40:38 +03:00
Ezio Melotti 963004d1d8 Fix typo. 2011-10-25 09:41:13 +03:00
Benjamin Peterson 1fafc1a11f document __bytes__ special method (closes #13259) 2011-10-25 00:03:51 -04:00
Benjamin Peterson d6ca6c2b32 note callable is back in 3.2 2011-10-24 08:51:15 -04:00
Florent Xicluna 023611f34e Issue 13141: Demonstrate recommended style for socketserver examples. 2011-10-23 22:40:37 +02:00
Petri Lehtinen ce77037503 Add the green "New reference" note to the doc of PyException_GetTraceback() 2011-10-23 21:03:33 +03:00
Ezio Melotti cd1d3ef77b #13233: fix typo. 2011-10-20 19:51:18 +03:00
Ezio Melotti 81231d9379 #13219: clarify section about character sets in the re documentation. 2011-10-20 19:38:04 +03:00