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

12002 Commits

Author SHA1 Message Date
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
Raymond Hettinger af37b89240 Issue 12668: Fix wording in Whatsnew3.2 2011-10-19 14:16:18 -07: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
Éric Araujo 9be57231dd Update dead references from py.org/dev/faq to the devguide (#13176) 2011-10-14 17:37:45 +02:00
Mark Dickinson f1ab47ebc4 Issue #13145. Fix incorrect documentation for PyNumber_ToBase. Thanks Sven Marnach. 2011-10-11 18:06:36 +01:00
Ezio Melotti 4e15828640 Fix/improve markup in whatsnew/2.7. 2011-10-10 00:30:14 +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 47a4521ece Fix distutils byte-compilation to comply with PEP 3147 (#11254). 
Patch by Jeff Ramnani.  Tested with -B, -O and -OO.
 2011-10-08 00:34:13 +02: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
Éric Araujo eb933de807 Fix current name of the Python 3 binary on Unix (#12896). 
Also fix some markup and typos.
 2011-09-09 19:03:41 +02:00
Vinay Sajip 4eb0e73ff2 Closes #12906: Fixed bug in YAML configuration. 2011-09-06 14:07:23 +01: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 fbd4fe2195 Give credit to Adam 2011-09-02 21:24:40 +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
Éric Araujo 8ab3a1d735 Document that True/False/None don’t use :keyword: in doc. 
This was discussed some months ago on python-dev.  Having tons of links
to the definition of True would be annoying, contrary to links to e.g.
the nonlocal or with statements doc.
 2011-09-01 18:45:50 +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 7af8ebb6ce Adapt/remove mentions of functions gone in 3.x 2011-09-01 03:20:13 +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
Éric Araujo 77443824f5 Document the "optional" argument of distutils’ Extension class 2011-08-26 00:45:18 +02:00
Éric Araujo 3f5e958a3f Fix type information in distutils API reference (#9302). 
Initial patch by Yue Shuaijie.
 2011-08-26 00:44:37 +02:00
Éric Araujo cc42ebe450 Make the list of docs contributors sorted again 2011-08-26 00:10:12 +02:00
Georg Brandl e1eef41a18 Close #12838: fix range() call. 2011-08-25 11:52:26 +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 2513123d66 Update suspicious ignore file. 2011-09-03 09:28:05 +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 f3c7822ee5 Adapt/remove mentions of functions gone in 3.x 2011-09-01 03:20:13 +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
Éric Araujo 72dde45dc6 Document the "optional" argument of distutils’ Extension class 2011-08-26 00:45:18 +02:00
Georg Brandl 852eea20ef Close #12838: fix range() call. 2011-08-25 11:52:26 +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 57bee66c03 Branch merge 2011-08-19 14:22:28 +02:00
Éric Araujo 355d48ad83 Typo 2011-08-19 09:28:46 +02:00
Éric Araujo 04ac59a22a Mention virtual subclasses in the glossary entry for ABCs (#12256). 
I added a link from the term “virtual subclass” to the glossary entry
for ABCs but this was not enough, now the glossary briefly defines
“virtual” and links to the abc module doc which contains more mentions
of virtual subclasses.
 2011-08-19 09:07:46 +02:00
Eli Bendersky f6854cb0f0 Issue #12672: remove confusing part of sentence in documentation 2011-08-19 06:29:51 +03:00
Eli Bendersky 729a42f263 Issue #12672: remove confusing part of sentence in documentation 2011-08-19 06:29:51 +03:00
Éric Araujo 4d71a66a01 Fix typo in command name 2011-08-19 03:44:36 +02:00
Éric Araujo a2d26182e2 Fix instance I missed in 59f7bbe1236c (#1626300) 2011-08-19 03:12:38 +02:00
Éric Araujo e197df06fb Remove obsolete term + indicate how to find the program (#1626300). 
Suggested by Terry J. Reedy.
 2011-08-19 02:30:15 +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
Éric Araujo 0519b09936 Avoid splitting a word between a link and text 2011-08-19 00:39:19 +02:00
Sandro Tosi b2761186af #12761: fix wording of zlib license section 2011-08-16 20:03:11 +02:00
Sandro Tosi f6b25b9e35 #12761: fix wording of zlib license section 2011-08-16 20:03:11 +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
Georg Brandl 96d237c40a Update versions in LICENSE files. 2011-08-13 11:59:12 +02:00
Georg Brandl 1db1d14e11 Update pydoc topics and suspicious ignore. 2011-08-13 11:33:35 +02:00
Sandro Tosi 7bf4363f77 let PySequence_Check me a link; thanks to tomo cocoa from docs@ 2011-08-13 00:39:46 +02: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
Benjamin Peterson 77c4fd01dd note mutating tp_dict is bad (closes #12719) 2011-08-09 16:07:01 -05:00
Éric Araujo da3f4ae34b Branch merge 2011-08-09 18:01:38 +02:00
Georg Brandl bdbdfb1978 Confirm that the prime example is actually correct. We get so many complaints about a "buggy example" on docs@python, let us hope this cuts them in half at least. 2011-08-08 21:45:13 +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 61baee0ee7 #10741: add documentation for PyGILState_GetThisThreadState() 2011-08-08 00:16:54 +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
Senthil Kumaran a3b2316a1b merge from 2.7 - Fix closes issue11047 - Correct the 2.7 whatsnew description for issue 7902. 2011-08-06 12:54:23 +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
Éric Araujo 2ffea0e8d7 Branch merge 2011-08-01 14:43:45 +02:00
Vinay Sajip 952595696a Closes #12667: Added documentation for SMTPHandler secure argument. 2011-08-01 11:31:52 +01:00
Ezio Melotti 222e61e444 Fix typo reported by Sandro Tosi. 2011-07-31 22:49:18 +03:00
Éric Araujo ab7c1b3f11 Fix regression with distutils MANIFEST handing (#11104, #8688). 
The changed behavior of sdist in 3.1 broke packaging for projects that
wanted to use a manually-maintained MANIFEST file (instead of having a
MANIFEST.in template and letting distutils generate the MANIFEST).

The fixes that were committed for #8688 (76643c286b9f by Tarek and
d54da9248ed9 by me) did not fix all issues exposed in the bug report,
and also added one problem: the MANIFEST file format gained comments,
but the read_manifest method was not updated to handle (i.e. ignore)
them.  This changeset should fix everything; the tests have been
expanded and I successfully tested the 2.7 version with Mercurial, which
suffered from this regression.

I have grouped the versionchanged directives for these bugs in one place
and added micro version numbers to help users know the quirks of the
exact version they’re using.

Initial report, thorough diagnosis and patch by John Dennis, further
work on the patch by Stephen Thorne, and a few edits and additions by
me.
 2011-07-31 04:06:12 +02:00
Ezio Melotti 592563292c #12531: Fix spaces and markup. 2011-07-30 21:25:22 +03: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
Eli Bendersky 7bd081c117 Issue #12531: add index entries to documentation of * and ** in function calls 2011-07-30 07:05:16 +03: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
Éric Araujo ee19c772cb Remove mentions of previous license in profile module docs (#12417 followup). 
Also remove an extra docstring.
 2011-07-28 22:56:24 +02:00
Éric Araujo f5e10d1f70 Turn raw URI into real link 2011-07-28 22:50:18 +02:00
Éric Araujo 14382dc887 Update documentation for shutil.move (#12043) and fix a few typos. 
Adding Sandro Tosi to Doc/ACKS for this patch and all his work on the
docs mailing list and on the bug tracker.
 2011-07-28 22:49:11 +02:00
Éric Araujo 72db3459e4 Make indentation comply with our style guide and the rest of the file 2011-07-26 16:54:24 +02:00
Éric Araujo 59e387eb40 Fix “anyways” (following R. David Murray in 4d5a546b6186) 2011-07-26 16:53:17 +02:00
Éric Araujo 7c12bae717 Fix reST references 2011-07-26 15:14:35 +02:00
Ross Lagerwall 59c01edcaa Issue #12102: Document that buffered files must be flushed before being used 
with mmap. Patch by Steffen Daode Nurpmeso.
 2011-07-25 07:12:43 +02:00
Georg Brandl 06ad13ee7c Fix function name: open -> urlopen. 2011-07-23 08:04:40 +02:00
Ezio Melotti bca31b5d1f #11435: link to the correct branch. 2011-07-21 09:35:19 +03:00
Senthil Kumaran 96c84a4c7d Fix closes issue12524 - update http.client POST example with a working example. 2011-07-20 21:56:24 +08:00
Senthil Kumaran ae4a78b0a8 Fix closes issue12577 - clarify shutil.move documentation. Patch suggestion by Catalin Iacob 2011-07-19 08:03:02 +08:00
Antoine Pitrou 0e752dd3f8 Issue #6476: Document that os.spawnle and os.spawnve are not thread-safe under Windows. 2011-07-19 01:26:58 +02:00
R David Murray b899007268 Better English. 2011-07-18 12:38:03 -04:00
Senthil Kumaran 3e7f33fc82 fix whitespace nit. 2011-07-18 07:17:20 +08:00
Senthil Kumaran 0215d09ca9 Fix closes Issue12478 - HTTPErrorProcess 's methods are http_response and https_response. 2011-07-18 07:12:40 +08:00
Senthil Kumaran ed270fab64 Fix closes Issue12479 - Add HTTPErrorProcessor class definition - Patch by Sandro Tosi 2011-07-18 06:42:46 +08:00
Senthil Kumaran 023c6f703d Fix Issue10403 - datetime documentation clarification based on review in the reitveld by Alexendar belopolsky. 2011-07-17 19:01:14 +08:00
Senthil Kumaran ad3882a2b0 Fix closes Issue11436 - Minor clarification to struct documentation for 's' format character. 2011-07-17 17:29:17 +08:00
Ned Deily 58e3350bd4 Issue #12549: Correct test_platform to not fail when OS X returns 'x86_64' 
as the processor type on some Mac systems.  Also fix NameError in fallback
_mac_ver_gestalt function.  And remove out-of-date URL in docs.
 2011-07-13 15:07:04 -07:00
Antoine Pitrou fd060474e3 Make it clear that PyNumber_AsSsize_t() returns -1 on error. 2011-07-13 21:02:22 +02:00
Georg Brandl 325eb470b7 Clarify that PyErr_NewException creates an exception *class*, not instance. 2011-07-13 15:59:24 +02:00
Antoine Pitrou b3593cada2 Use infinitive, not 3rd person of present tense. 2011-07-11 01:39:19 +02:00
Antoine Pitrou 6f5dcb1ee2 Issue #12343: Add some notes on behaviour of non-blocking SSL sockets. 2011-07-11 01:35:48 +02:00
Antoine Pitrou cdddf2b875 Mention logging.captureWarnings in the warnings module doc. 2011-07-09 21:29:36 +02:00
Antoine Pitrou 462d1b39a4 Move sys.subversion at the right place in alphabetical order, and informally deprecate it. 2011-07-09 16:02:19 +02:00
Antoine Pitrou a83cdaae89 Issue #12326: document the recommended idiom for checking sys.platform on Unix systems. 
Also, point to the various alternatives.
 2011-07-09 15:54:23 +02:00
Victor Stinner 6e2e3b9e81 Issue #12423: Fix os.abort() documentation 
The Python signal handler for SIGABRT is not called on os.abort() (only if the
signal is raised manually or sent by another process). Patch by Kamil Kisiel.
 2011-07-08 02:26:39 +02:00
Senthil Kumaran 3aac179498 Fix whitespace nit in datetime and os rst files. 2011-07-04 11:43:51 -07:00
Senthil Kumaran a6bac95a3c issue10403 - Let's not use members anymore. Use 'attribute' where it denotes attribute and 'methods' where it denotes methods. Context should clarify usage. 2011-07-04 11:28:30 -07:00
Georg Brandl bfd1edd155 Merge 3.2.1 release clone changes into main 3.2 branch after 3.2.1rc2 release. 2011-07-04 19:55:22 +02:00
Senthil Kumaran 946eb865a3 reST indentation fix in sqlite3 docs. rst uses 3 space indentation. 2011-07-03 10:17:22 -07:00
Georg Brandl f069100d0d Fix bad markup. 2011-07-03 09:39:49 +02:00
Georg Brandl 7f3cd98beb Fix target path in message. 2011-07-03 09:30:42 +02:00
Mark Dickinson 40d9ebe031 Issue #12228: Fix exchanged flag descriptions in stat.rst. Thanks Sandro Tosi. 2011-06-25 12:03:33 +02:00
Senthil Kumaran fe9230aac6 Fix closes issue12261 - Minor documention changes in the urllib.parse.rst 2011-06-19 13:52:49 -07:00
R David Murray ac4e5abc78 #12147: make send_message correctly handle Sender and Resent- headers. 
Original patch by Nicolas Estibals.  My tweaks to the patch were mostly
style/cosmetic, and adding more tests.
 2011-07-02 21:03:19 -04:00
Ned Deily 3eb67d58d6 Issue #8746: Correct faulty configure checks so that os.chflags() and 
os.lchflags() are once again built on systems that support these
functions (*BSD and OS X).  Also add new stat file flags for OS X
(UF_HIDDEN and UF_COMPRESSED).  Also add additional tests for
os.chflags() and os.lchflags(). (Tests by Garrett Cooper)
 2011-06-28 00:00:28 -07:00
Raymond Hettinger b34705ff37 Issue #8890: Remove /tmp from examples. 2011-06-26 15:29:06 +02:00
Ezio Melotti 4850d52b4d #11363: add missing functions from curses doc. Patch by Sandro Tosi. 2011-06-26 13:34:56 +03:00
Ezio Melotti b6b7371329 #11363: clean up curses doc. 2011-06-26 13:38:11 +03:00
Ezio Melotti fc3db8a91e #11669: rephrase footnote in the Compound Statements page. 2011-06-26 11:25:28 +03:00
Ezio Melotti 54cc5fd72d Use correct markup in zipimport.rst. Patch by Sara Magliacane. 2011-06-25 19:40:06 +03:00
Raymond Hettinger 6ddefd7916 Issue 12086: add example showing how to use name mangling. 2011-06-25 16:30:39 +02:00
Raymond Hettinger 9d3df6d508 Issue 11889: Clarify docs for enumerate. 2011-06-25 15:00:14 +02:00
Mark Dickinson 7e4b5c6773 Merge #12228 2011-06-25 12:04:08 +02:00
Raymond Hettinger 4d5208d2e2 Fix typo (reported by Hiro Ashiya). 2011-06-25 11:39:00 +02:00
R David Murray 24eb4bc5c9 #9921: clarify os.path.join joining algorithm 
The new wording is based on the comments in the code, which
match the actual behavior.
 2011-06-23 21:26:13 -04:00
Senthil Kumaran 4707a998e4 Fix closes Issue12359 - Removing a confusing sentence from the previous change. 2011-06-20 07:30:34 -07:00
Senthil Kumaran 656df5ec3e Fix closes issue 12360 - correcting parameter names in asyncore documentation. 2011-06-19 18:22:33 -07:00
Senthil Kumaran 150857028c minor space nit. 2011-06-19 17:41:33 -07:00
Senthil Kumaran 5c0347b398 Fix closes Issue12359 - Minor update to module import description. 2011-06-19 17:37:06 -07:00
Senthil Kumaran fd8d7e9b0d Whitespace nit fixed using reident. 2011-06-19 16:59:41 -07:00
Senthil Kumaran ce9b596c04 Fix closes Issue12315 - Updates to http.client documentation. 2011-06-19 16:56:49 -07:00
Senthil Kumaran a977acc0fe merge from 3.1 for issue issue12261. 2011-06-19 13:55:48 -07:00
R David Murray 409c32f47c #6771: fix docs: curses.wrapper is exposed as a function, not a module 
Patch by July Tikhonov.
 2011-06-18 19:34:12 -04:00
Benjamin Peterson b4cfa3ad63 merge heads 2011-06-16 18:51:24 -05:00
Benjamin Peterson a08eb73b4a update link to pycrypto (closes #12351) 2011-06-16 18:49:46 -05:00
Raymond Hettinger a63d45c825 Fix typo. 2011-06-16 22:32:10 +01:00
Éric Araujo 8ddf7c2d2b Minor wording improvement 2011-06-15 17:49:20 +02:00
Vinay Sajip cdc751720e Updated Formatter.formatTime documentation. 2011-06-12 11:44:28 +01:00
Vinay Sajip 0aaa9e1d7b Issue #12206: documentation for LogRecord constructor updated re. the level argument. 2011-06-11 23:03:37 +01:00
Éric Araujo 9fbfe15c86 Add missing reST target to one heading in the tutorial 2011-06-11 10:34:19 +02:00
Vinay Sajip 645e4589b1 Documented change for Issue #12168. 2011-06-10 18:52:50 +01:00
Éric Araujo d2f8cec885 Fix a few misuses of :option: I missed in r86521. 
Extract of the commit message:

  Fix usage of :option: in the docs (#9312).

  :option: is used to create a link to an option of python, not to mark
  up any instance of any arbitrary command-line option.  These were
  changed to ````.
 2011-06-08 05:29:39 +02:00
Éric Araujo 96deb7550e Add links from builtins module docs to built-in functions and constants docs 2011-06-08 04:53:20 +02:00
Éric Araujo b805c47138 Add examples that work on Windows to distutils docs (#1626300) 2011-06-08 01:11:36 +02:00
Éric Araujo b8f2ad0380 Remove outdated bit of advice (584f9c213a6d follow-up) 2011-06-08 00:47:49 +02:00
Éric Araujo fa088dbd0c Improve glossary entry for ABCs. 
- Rename reST target name for collections ABCs to avoid collisions
- Add link to importlib ABCs (collections, numbers and io ABCs were already
  linked)
- Link to glossary entry from numbers module doc (other modules already do it)
 2011-06-04 18:42:38 +02:00
Éric Araujo 07e58c3389 Remove link that’s already present at the top of the file 2011-06-03 20:43:42 +02:00
Éric Araujo 98e68adc7e Document working dir for “make html” (#12249). Patch by Tshepang Lekhonkhobe. 2011-06-03 19:25:58 +02:00
Raymond Hettinger 3d89057ff8 Fix named tuples to work with vars(). 2011-06-02 23:40:24 -07:00
Raymond Hettinger 9028928156 Forward port doc updates for builtin functions. 2011-06-01 16:17:23 -07:00
Éric Araujo affcf2967f Branch merge 2011-06-01 19:39:27 +02:00
Benjamin Peterson 2e3a38a774 demote this to a note 2011-05-31 21:27:41 -05:00
Éric Araujo 5864b9fd3c Fix markup: arguments in a class directive are __init__ arguments, not base classes 2011-05-31 21:50:38 +02:00
Éric Araujo 75e86a678c Merge 3.1 2011-05-29 18:07:12 +02:00
Éric Araujo 4b8f6651f0 Branch merge 2011-05-29 18:05:53 +02:00
Éric Araujo 87418afb3b Fix typo in 0311f62714f7 2011-05-29 03:48:49 +02:00
Éric Araujo 6a21f5527c Don’t misuse “package data” in pprint example 2011-05-29 03:46:31 +02:00
Éric Araujo c5069e0070 Merge doc touch-ups and fixes for #9831 and #9223 from 3.1 2011-05-29 00:29:56 +02:00
Éric Araujo 456ae893d7 Re-add missing doc stub for the distutils check command 2011-05-29 00:22:06 +02:00
Éric Araujo 000893fab2 Minor touch-ups in distutils.cmd.Command doc 2011-05-29 00:14:45 +02:00
Éric Araujo f33de71514 Minor doc addition for clarity 2011-05-27 04:42:47 +02:00
Éric Araujo e0854f9dbf Add missing closing paren 2011-05-27 04:36:52 +02:00
Éric Araujo d4701f4262 Fix two typos 2011-05-25 18:13:29 +02:00
Raymond Hettinger 4b244ef255 Clean-up example. 2011-05-23 12:45:34 -07:00
Eli Bendersky 2f1b3962a2 Issue 12126: removing incorrect claim about return value of select 
merge 3.1 -> 3.2
 2011-05-22 06:57:17 +03:00
Eli Bendersky 46ab96a0c8 Issue 12126: removing incorrect claim about return value of select 2011-05-22 06:56:15 +03:00
Raymond Hettinger f9ca76f500 Simplify example 2011-05-21 09:33:45 -07:00
Georg Brandl 9c1928f0a9 Merge release branch after 3.2.1rc1. 2011-05-21 17:35:33 +02:00
Benjamin Peterson 619323c68f merge 3.1 2011-05-20 11:49:19 -05:00
Benjamin Peterson 2340986fe0 this should actually be an IOError 2011-05-20 11:49:06 -05:00
Benjamin Peterson c7dd737ef7 merge 3.1 2011-05-20 11:41:59 -05:00
Benjamin Peterson 249b508c98 add example for not using access 2011-05-20 11:41:13 -05:00
Ezio Melotti da5b852c7c #12072: merge with 3.1. 2011-05-20 15:06:32 +03:00
Ezio Melotti 261d855fd6 #12072: add missing parenthesis in the doc. Patch by Sandro Tosi. 2011-05-20 15:04:38 +03:00
Georg Brandl 521143dd6c Update pydoc topics and handle suspicious markup. 2011-05-15 17:51:24 +02:00
Georg Brandl 318e62153b Merge #6498 fix from 3.1. 2011-05-15 08:49:29 +02:00
Georg Brandl 0b2489e986 Closes #6498: fix several misspellings of "SystemExit" as "SystemError". 2011-05-15 08:49:12 +02:00
Łukasz Langa d8eab60c00 Merged rethought pprint usage example from 3.1. 2011-05-14 22:49:10 +02:00
Łukasz Langa 4ad78ab766 pprint usage example rethought. 2011-05-14 22:43:44 +02:00
Ezio Melotti 132bcf4724 #11979: merge with 3.1. 2011-05-14 09:23:52 +03:00
Ezio Melotti eda199030b #11979: improve wording and markup in sockets howto. Patch by Xavier Morel. 2011-05-14 09:17:52 +03:00
Raymond Hettinger 23157e5ddc Further beautification of the example 2011-05-13 01:38:31 -07:00
Raymond Hettinger 9c47d778f7 Neaten up example so it can be cut and pasted. 2011-05-13 01:03:50 -07:00
Georg Brandl 5166375045 Use singular they. Thanks to Mark Summerfield. 2011-05-13 06:55:28 +02:00
Georg Brandl 325477e20e Fix unbound local error in RE tokenizer example. Thanks to Herman L. Jackson. 2011-05-13 06:54:23 +02:00
Georg Brandl cc5ea6860f Merge in changes from 3.2.1b1 release repo. 2011-05-13 06:50:56 +02:00
Gregory P. Smith c9557af441 merge - 7a3f3ad83676 Fixes Issue #12044. 2011-05-11 22:18:23 -07:00
Raymond Hettinger 30439b23c0 Document default fmtspec. Fix inaccurate note. Document exceptions. 2011-05-11 10:47:27 -07:00
Senthil Kumaran 57e6eac905 Issue #11968 - the start_response header values in wsgiref shoudl be str not 
bytes. The PEP-0333 says that and test_wsgiref follows the same.  Updated docs
accordingly.
 2011-05-11 22:34:59 +08:00
Antoine Pitrou 1be815aac4 Issue #8498: In socket.accept(), allow to specify 0 as a backlog value in 
order to accept exactly one connection.  Patch by Daniel Evers.
 2011-05-10 19:16:29 +02:00
Łukasz Langa cda41d3bf7 Actually print out the description of what changed. 2011-05-10 15:25:41 +02:00
Raymond Hettinger bb1cf8d9bc Issue 12047: Expand the style guide. 2011-05-10 00:35:03 -07:00
Victor Stinner 17ca323e7c (Merge 3.1) Issue #12012: ssl.PROTOCOL_SSLv2 becomes optional 
OpenSSL is now compiled with OPENSSL_NO_SSL2 defined (without the SSLv2
protocol) on Debian: fix the ssl module on Debian Testing and Debian Sid.

Optimize also ssl.get_protocol_name(): speed does matter!
 2011-05-10 00:48:41 +02:00