Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
49,813 Commits 6 Branches 592 Tags 2.4 GiB
Commit Graph

2823 Commits

Author SHA1 Message Date
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
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 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
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
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 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
Lars Gustäbel 0c6cbbd632 Fix doc typo. 2011-12-10 12:45:45 +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
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
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
É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
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
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
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 e348455f5f document turtle done() function; thanks to Csaba Szepesvari from docs@ 2011-10-31 10:12:43 +01:00
Raymond Hettinger 6f45d18c24 Improve itertools docs with clearer examples of pure python equivalent code. 2011-10-30 15:06:14 -07: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
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 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
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
Raymond Hettinger 5768e0c788 Issue 11931: Minor punctuation/grammar/wording fixups to the regex docs 2011-10-19 14:10:07 -07:00
Senthil Kumaran 29fa9d4d68 3.2 - Fix closes Issue6090 - Raise a ValueError, instead of failing with unrelated 
exceptions, when a document with timestamp earlier than 1980 is provided to
zipfile. Patch contributed by  Petri Lehtinen.
 2011-10-20 01:46:00 +08:00
Ezio Melotti e130a52d8a Remove duplication. 2011-10-19 10:58:56 +03:00
Ezio Melotti 67494f2224 #12277: add missing comma. 2011-10-18 12:59:39 +03:00
Ezio Melotti 138fc896c8 #13138: add missing versionadded. 2011-10-10 00:02:03 +03:00
Raymond Hettinger df7c4cde48 Clean-up and improve the priority queue example in the heapq docs. 2011-10-09 17:28:14 +01:00
Éric Araujo 35a502b324 Fix a typo and a broken link (part of #10536). 
Found by Franz Glasner in #2504.
 2011-10-07 22:02:58 +02:00
Antoine Pitrou f394e47851 Issue #12823: remove broken link and replace it with another resource. 2011-10-07 16:58:07 +02:00
Éric Araujo bb2095f1e2 Branch merge 2011-10-06 13:10:34 +02:00
Senthil Kumaran ad87fa6719 Issue #13073 - Address the review comments made by Ezio. 2011-10-05 23:26:49 +08:00
Éric Araujo 58a9153c9f Fix markup used in the documentation of sys.prefix and sys.exec_prefix. 
- Using the file role with {placeholders} is IMO clearer than fake
  Python code.

- The fact that sys.version[:3] gives '3.2' is a CPython detail and
  should not be advertised (see #9442), even if some stdlib modules
  currently rely on that detail.
 2011-10-05 01:28:24 +02:00
Éric Araujo da27263b4a Move doc of sys.dont_write_bytecode to make all attributes sorted again 2011-10-05 01:17:38 +02:00
Senthil Kumaran 5d0de3fbaa Document message_body arg in HTTPConnection.endheaders 2011-10-03 07:27:06 +08:00
Ezio Melotti 35ec7f771b #13076: fix links to datetime.time and datetime.datetime. 2011-10-02 12:44:50 +03:00
Senthil Kumaran 17dac4c0e2 Fix closes issue13005 - Remove the mention of 'repeat' method in the operator module documentation. 2011-09-22 02:09:17 +08:00
Georg Brandl 1d678f8413 Fix bug in heapq priority queue example. 2011-09-18 07:40:05 +02:00
Georg Brandl 73dd7c71f6 Add info from the docstring for random.gammavariate() to the docs. 2011-09-17 20:36:28 +02:00
Georg Brandl 755460694e Fix typo. 2011-09-17 20:20:04 +02:00
Ezio Melotti 4165bfb6e9 #12940: fix cmd example. Patch by Tim Chase. 2011-09-10 10:06:01 +03:00
Senthil Kumaran e969a2117c Fix closes Issue11155 - Correct the multiprocessing.Queue.put's arg (replace 'item' with 'obj') in the docs. Patch by Westley Martínez. 2011-09-06 00:21:30 +08:00
Georg Brandl 3484a8771c Merge with release clone. 2011-09-04 08:35:54 +02:00
Łukasz Langa 7335e6f3e8 removed misleading editing leftovers 2011-09-02 23:17:39 +02:00
Sandro Tosi 172f374a63 #12781: Mention SO_REUSEADDR flag near socket examples 2011-09-02 20:06:31 +02:00
Éric Araujo d9e1789364 Branch merge 2011-09-02 17:30:36 +02:00
Éric Araujo 18ddf826e7 Add links from library/functions to other docs. 
Suggested by Terry J. Reedy in #12298.
 2011-09-01 23:10:36 +02:00
Éric Araujo 9edd9f035b Fix a few links in the table of built-in functions (#12298) 2011-09-01 23:08:55 +02:00
Éric Araujo 29cf58c9d5 Document that format string don’t support arbitrary dictonary keys. 
Text adapted from the PEP.  Addition requested by Terry J. Reedy on
2011-02-23 on python-dev.
 2011-09-01 18:59:06 +02:00
Ezio Melotti 222b20844f From RFC 3629 5- and 6-bytes UTF-8 sequences are invalid, so remove them from the doc. 2011-09-01 08:11:28 +03:00
Ross Lagerwall a9353db2cd Remove duplicate text in os documentation. 2011-09-01 06:58:52 +02:00
Éric Araujo ec9a5f6399 Add version number for versionchanged directive (backport from 3.3) 2011-09-01 05:55:26 +02:00
Éric Araujo 37b5f9eebc Fix some misuses of Sphinx roles and one typo 2011-09-01 03:19:30 +02:00
Éric Araujo 941afedd74 Avoid using the default reST role. Makes Doc/tools/rstlint.py happy. 2011-09-01 02:47:34 +02:00
Éric Araujo be573e7d17 Remove outdated pointer to optparse (fixes #11360). 
The doc already points to argparse.
 2011-08-26 16:38:40 +02:00
Antoine Pitrou 13d2895dbf Issue #12213: make it clear that BufferedRWPair shouldn't be called with the 
same object as reader and writer, and deemphasize it in document order.
 2011-08-20 19:48:43 +02:00
Sandro Tosi 9daf98d32a #12787: link original MultiCall proposal to webarchive and in a footnote 2011-08-20 17:05:56 +02:00
Georg Brandl a47e53e42e Update sys.platform doc for #12326. 2011-09-03 09:26:09 +02:00
Łukasz Langa 987b188615 removed misleading editing leftovers 2011-09-02 23:17:39 +02:00
Sandro Tosi 335f204977 #12781: Mention SO_REUSEADDR flag near socket examples 2011-09-02 20:06:31 +02:00
Éric Araujo d86ac4cd4e Document that format string don’t support arbitrary dictonary keys. 
Text adapted from the PEP.  Addition requested by Terry J. Reedy on
2011-02-23 on python-dev.
 2011-09-01 18:59:06 +02:00
Éric Araujo 7bb769c092 Add version number for versionchanged directive (backport from 3.3) 2011-09-01 05:55:26 +02:00
Éric Araujo 43ba354599 Fix some misuses of Sphinx roles and one typo 2011-09-01 03:19:30 +02:00
Éric Araujo 217607ecde Remove outdated pointer to optparse (fixes #11360). 
The doc already points to argparse.
 2011-08-26 16:38:40 +02:00
Antoine Pitrou dc42beb55e Issue #12213: make it clear that BufferedRWPair shouldn't be called with the 
same object as reader and writer, and deemphasize it in document order.
 2011-08-20 19:48:43 +02:00
Sandro Tosi 6a633bb878 fix description of \r; thanks to Thomas Waldmann from docs@ 2011-08-19 22:54:50 +02:00
Sandro Tosi e1043fc230 fix description of \r; thanks to Thomas Waldmann from docs@ 2011-08-19 22:54:50 +02:00
Sandro Tosi 2f394f6666 mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@ 2011-08-19 18:40:21 +02:00
Sandro Tosi f693810f69 mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@ 2011-08-19 18:40:21 +02:00
Éric Araujo e8b7eb07e1 Link isinstance/issubclass to the ABC glossary entry (#12256) 2011-08-19 02:17:03 +02:00
Éric Araujo 543edbdab8 Don’t quote characters twice. 
``code`` markup is enough to mark command-line fragments or to talk
about a character.  ``'c'`` is still used for actual Python string
objects.  I did a similar change in optparse.rst in r86521.

I’ve also ported two minor changes from the 3.3 version of the file
(removing an unnecessary module name in a class directive, adding a
comma).
 2011-08-19 01:45:12 +02:00
Éric Araujo fde9242631 Don’t use “arg” for “argument” 2011-08-19 01:30:26 +02:00
Éric Araujo 19f9b71ffe Add a few missing source links from 2.7 and harmonize lib docs headers 2011-08-19 00:49:18 +02:00
Éric Araujo d001ffe745 Minor improvements to BadZipFile and BadZipfile docs. 
I made the doc for the compat alias BadZipfile shorter and used a
directive to document deprecation.

I figured there was no point of talking about zipfile.error (“the old
name” that’s older than the other old name BadZipfile) in the 3.x docs
so I just removed it.
 2011-08-19 00:44:31 +02:00
Éric Araujo 5eada94163 Fix markup to get a target instead of a comment 2011-08-19 00:41:23 +02:00
Éric Araujo 889a7dcb3a Fix a typo and touch up blank lines 2011-08-19 00:40:46 +02:00
Éric Araujo 6e7d0ba309 Add missing reST target for one section of this file 2011-08-19 00:39:57 +02:00
Ezio Melotti 0656a56214 #12204: document that str.upper().isupper() might be False and add a note about cased characters. 2011-08-15 14:27:19 +03:00
Ezio Melotti f42121f27e #12725: fix working. Patch by Ben Hayden. 2011-08-14 08:28:57 +03:00
Ezio Melotti 388c945e97 #12725: fix working. Patch by Ben Hayden. 2011-08-14 08:28:57 +03:00
Sandro Tosi 8a3b657f9e it's 'rather than'; reported by James Bateman on docs@ 2011-08-12 19:31:32 +02:00
Éric Araujo 28d39a0c08 Branch merge 2011-08-12 17:40:25 +02:00
Vinay Sajip 817495a631 Issue #12718: Add documentation on using custom importers. 2011-08-11 13:45:48 +01:00
Éric Araujo d9d7bca6da Use real word in English text (i.e. not code) 2011-08-10 04:19:03 +02:00
Éric Araujo 54a1d05877 Branch merge 2011-08-08 16:56:00 +02:00
Sandro Tosi db79e95195 #12709: add error_callback argument to map_async documentation 2011-08-08 16:38:13 +02:00
Sandro Tosi 2a389e4601 #12677: correct turtle orientation in doc 2011-08-07 17:12:19 +02:00
Éric Araujo 6ef038e78c Add documentation for PEP 370 features in distutils (#10745). 
This started out as an easy task, just add a section describing this
alternate scheme, but I found a lot of cleanup to do along the way:

- fixed inverted reST targets
- fixed entries for modules (hi abiflags!) or data files
- avoided duplicating the same options listing five or six times
- added missing entries for C headers locations
- added documentation for --install-lib
- fixed a few misuses of the option role (see #9312), but not all (not
  worth the time, but will do it in packaging docs)
- fixed some markup

The paths fixes were done with an eye on the source code in the install
command, so they really describe what’s actually done.  The situation on
Mac OS X is rather messy: the fix for #8084 touched site and sysconfig,
but distutils doesn’t use these files.  I suspect we have a mismatched
stdlib at the moment, and the fix is not even clear (see the bug report
for further discussion).
 2011-08-06 16:30:42 +02:00
Eli Bendersky ebd4805df0 Fix grammar 2011-08-06 09:31:09 +03:00
Senthil Kumaran 2e0153550c Fix closes Issue12697 - Update the usage syntax of timeit module in the docs. 2011-08-06 13:37:04 +08:00
Éric Araujo de4f05b741 Improve documentation for PEP 370 support in site module (#8617). 
site.USER_BASE and site.USER_SITE are now fully documented.  PEP 370 is
outdated with respects to the Mac framework situation, but the code in
sysconfig and the example in the 3.2 What’s New document helped me find
the right values to document for Mac OS X.

The command-line interface of the site module, partly documented in the
3.2 What’s New, is fully described in the module docs.

The purpose of the usercustomize module is explained in the site docs,
with a gentle introduction in the tutorial (right after the section that
talks about PYTHONSTARTUP; a comment mentions it should be moved from
the tutorial to another file, but that will be another bug).

Various markup and wording improvements were made along the way in the
site module docs.  Duplicate and incomplete declarations of environment
variables have also been removed (the original bug report was actually
about these entries :).  The site module docs are still a bit messy;
I’ll see about improving them for #11553.

All these sections are copiously interlinked and findable from the doc
indexes.
 2011-08-06 01:51:07 +02:00
Senthil Kumaran 86a1a8974d Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi. 2011-08-03 07:42:18 +08:00
Sandro Tosi 2a8d195328 #12665: Dictionary view example has error in set operation 2011-08-02 18:42:04 +02:00
Sandro Tosi 692dba244b #12670: Fix struct code after forward declaration on ctypes doc 2011-08-02 16:17:14 +02:00
Senthil Kumaran ef5c716176 Fix closes Issue12183 - Explain the Symlink copy behavior in shutil.copytree. Patch by Petri Lehtinen. 2011-08-02 18:52:28 +08:00
Georg Brandl aa71583f09 Use attribute access instead of index access for namedtuple. 2011-08-01 22:58:53 +02:00
Vinay Sajip 952595696a Closes #12667: Added documentation for SMTPHandler secure argument. 2011-08-01 11:31:52 +01:00
Benjamin Peterson 497cd65cec add space 2011-07-30 09:59:50 -05:00
Benjamin Peterson 50211fa0f9 document NotImplemented 2011-07-30 09:57:24 -05:00
Eli Bendersky b603b27775 merging Georg's revision 2011-07-30 11:36:41 +03:00
Eli Bendersky e250358062 Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen 2011-07-30 11:14:32 +03:00
Georg Brandl eea6cda91a Change test.support docs to be more specific about the nature of this module. 2011-07-30 09:00:48 +02:00
Éric Araujo fe1e298d8b Document that atexit execution order is undefined (#9788) 2011-07-29 18:04:24 +02:00
Éric Araujo 63b18a4445 Add a link target for argparse.Namespace (#8982) 2011-07-29 17:59:17 +02:00
Éric Araujo e801aa2a1d Let the doc of __import__ link to importlib (#9254). 
importlib.import_module eschews a number of issues that __import__ has.
Reviewed by Brett Cannon.  (The docstring of __import__ was already
updated in 3d490c3a019e, for #7397.)
 2011-07-29 17:50:58 +02:00
Éric Araujo 158d7696f3 Branch merge 2011-07-29 14:24:08 +02:00
Eli Bendersky ef4902af87 Issue #12644: document the '%a' conversion in the old string formatting operations. Patch prepared together with Ezio Melotti 2011-07-29 09:30:42 +03:00
Éric Araujo cf534817ad Branch merge 2011-07-28 23:08:11 +02:00
Éric Araujo fc662ddda2 Merge profile docs followup (#12417) from 3.1 2011-07-28 23:00:14 +02:00