Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
65,709 Commits 6 Branches 598 Tags 2.6 GiB
Commit Graph

2768 Commits

Author SHA1 Message Date
Georg Brandl b45c5e2d0e Closes #14489: correct link target. 2012-04-05 09:04:40 +02:00
R David Murray 5fc56eb1ca #14481: fix formatting of example in subprocess docs. 2012-04-03 08:46:05 -04:00
Sandro Tosi 6ca845c66a use unittest.skip; thanks to Chang Min Jeon from docs@ 2012-03-31 18:34:42 +02:00
Sandro Tosi 04cd09552a add 'safari' to webbrowser browsers table; thanks to Jonathan Eunice from docs@ 2012-03-31 17:22:47 +02:00
R David Murray 5080cad646 #10423: clarify options vs args in argparse discussion of optparse 
Patch by Sandro Tosi.
 2012-03-30 18:09:07 -04:00
R David Murray de294ec02e #14416: add missing LOG_SYSLOG facility to syslog docs. 2012-03-29 06:47:59 -04:00
Sandro Tosi 48a88953cc Issue #14410: fix typo in argparse doc; patch by Tshepang Lekhonkhobe 2012-03-26 19:35:52 +02:00
Vinay Sajip 49d5fbab87 Minor documentation tweak. 2012-03-26 17:06:44 +01:00
Georg Brandl 94a105705f Closes #14250: regex.flags has not only explicit flags but also those from the pattern 2012-03-17 17:31:32 +01:00
Georg Brandl 5a607b06d6 Closes #14343: avoid shadowing builtin input() in example code. 2012-03-17 17:26:27 +01:00
Georg Brandl ce54617260 Closes #14342: remove out-of-date section about avoiding recursion errors. 2012-03-17 17:25:47 +01:00
Senthil Kumaran e3d73544ad explain json.dumps for non-string keys in dicts. closes issue6566. Patch contributed Kirubakaran Athmanathan 2012-03-17 00:37:38 -07:00
R David Murray bee24df3a7 #11780: s/throw/raise/ 2012-03-16 22:11:22 -04:00
R David Murray 0cc4e53d1d #11780: document that email.encoders throw TypeError on multipart messages. 2012-03-16 22:06:08 -04:00
R David Murray 32a3b147b2 #12758: removing confusing mention of UTC from time.time description 
Patch by Dylan Sarber.
 2012-03-15 03:05:01 -04:00
Senthil Kumaran 15b6f3f825 Fix closes issue14258 - added clarification to \W and \S flags 2012-03-11 20:37:39 -07:00
Mark Dickinson 5081957642 Closes #9574: Note that complex constructor doesn't allow whitespace around central operator. 2012-03-10 16:09:35 +00:00
Jason R. Coombs d6a80ee2c7 Use PEP-8 style in logging example 2012-03-07 10:24:04 -05:00
Éric Araujo d2e19b5173 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:44:49 +01:00
Eli Bendersky 2b65408dec Issue #11379: add a note in xml.dom.minidom suggesting to use etree in some cases 2012-03-02 07:45:55 +02:00
Petri Lehtinen a15a8d2a0c sqlite3: Port relevant documentation changes from 3.2 
Initial patch by Johannes Vogel. Issue #13491.
 2012-03-01 21:48:30 +02:00
Ezio Melotti d9de93eb67 #14155: remove duplication about search vs match in re doc. 2012-02-29 13:37:07 +02:00
Ezio Melotti 38ae5b2392 #10713: Improve documentation for \b and \B and add a few tests. Initial patch and tests by Martin Pool. 2012-02-29 11:40:00 +02:00
Éric Araujo 92904d3a4a Branch merge 2012-02-26 03:48:36 +01:00
Éric Araujo 6d37c4e388 Add versionadded for sys.flags.hash_randomization variable 2012-02-26 02:03:39 +01:00
Éric Araujo 060b812a4b Fix markup errors 2012-02-26 02:00:35 +01:00
Éric Araujo a318a3b2fb Avoid relying on the default reST role in logging library doc 2012-02-26 01:36:31 +01:00
Éric Araujo c446ce78b8 Document that shutil.make_archive does not typecheck its logger argument 2012-02-26 01:33:49 +01:00
Éric Araujo d4e714c746 Fix typo (#13467) 2012-02-26 01:29:09 +01:00
Éric Araujo c8e29dba91 Mark up constants in socket doc as such 2012-02-26 01:25:11 +01:00
Éric Araujo c3cc2acb09 Improve interlinking of archiving/compression modules docs. 
- Remove duplicate 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-02-26 01:10:14 +01:00
Sandro Tosi 8b48c66ebd Issue #13999: refer to multiprocessing.Queue when needed 2012-02-25 19:35:16 +01:00
Benjamin Peterson aee9dfba4a merge 2.6 with hash randomization fix 2012-02-20 21:44:56 -05:00
Barry Warsaw 1e13eb084f - Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED 
environment variable, to provide an opt-in way to protect against denial of
  service attacks due to hash collisions within the dict and set types.  Patch
  by David Malcolm, based on work by Victor Stinner.
 2012-02-20 20:42:21 -05:00
Vinay Sajip 7d13cd3f5d logging: clarified documentation for Handler.handleError. 2012-02-20 18:34:07 +00:00
Éric Araujo bb42f5ed7f Add missing “::” markup and wrap overlong lines 2012-02-20 02:08:01 +01:00
Sandro Tosi 8d38fcf5a9 Refer to 'time' and 'datetime' submodules; thanks to Erik Johnson from docs@ 
This is needed after the move to Sphinx 1.x and it's the same way 3.x braches
managed it.
 2012-02-18 20:28:35 +01:00
Ezio Melotti c39b552603 #14020: improve HTMLParser documentation. 2012-02-18 01:46:04 +02:00
Petri Lehtinen 002b202009 Fix errors in sqlite3's Cursor.rowcount documentation 
Closes #13995.
 2012-02-16 21:42:34 +02:00
Sandro Tosi c0b1172459 Issue #11836: document multiprocessing.queues.SimpleQueue 2012-02-15 22:39:52 +01:00
Éric Araujo d9756beb87 Improve doc for atexit.register (#12297) 2012-02-15 17:08:34 +01:00
Senthil Kumaran ef18737b7f shutil copy module reference doc fix. 2012-02-13 23:17:45 +08:00
Gregory P. Smith 12426998ce 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:51:21 -08:00
Senthil Kumaran 59e7c8f177 Issue #9021: Add an introduction to the copy module. Doc changes suggested by Terry Reedy. 2012-02-09 18:22:01 +08:00
Senthil Kumaran 607e31eddf Fix Issue #6005: Examples in the socket library documentation use sendall, 
where relevant, instead send method. Patch contributed by Brian Brazil.
 2012-02-09 17:43:31 +08:00
Nadeem Vawda d15c5a869d Clarify note in BZ2File docs about lack of multi-stream support (issue #1625). 2012-02-05 14:27:01 +02:00
Georg Brandl 922ae2c931 Closes #13944: fix capitalization of class name. 2012-02-05 09:25:22 +01:00
Nadeem Vawda acd51f9ea9 Issue #1625: Document BZ2File's lack of support for multi-stream inputs. 2012-02-04 23:43:25 +02:00
Petri Lehtinen fe6f9d0edc Document absoluteness of sys.executable 
Closes #13402.
 2012-02-02 21:26:05 +02:00
Raymond Hettinger 65de77ed9e Clean-up docs for input() 2012-02-02 00:52:33 -08:00
Raymond Hettinger 6d837a3769 Add pure python equivalent code for reduce(). 2012-02-02 00:48:46 -08:00
Raymond Hettinger c5f310c827 Clarify the note for UserList 2012-02-01 19:00:09 -08:00
Raymond Hettinger 1d23199791 Use validate SQL in the example (this was confusing to readers) 2012-02-01 13:41:11 -08:00
Raymond Hettinger 81a55c01b8 Show the import in the sqlite3 example 2012-02-01 13:32:45 -08:00
Brian Curtin 3c8807bd5e merge. 2012-02-01 15:22:50 -06:00
Brian Curtin b4bef305fd merge from fb225c289bf0 2012-02-01 15:17:39 -06:00
Raymond Hettinger 6ab9813605 Use xrange in the example 2012-02-01 08:55:21 -08:00
Raymond Hettinger 9f55b63060 fix whitespace 2012-02-01 08:54:14 -08:00
Raymond Hettinger bdb7fe4c84 Add a usage note 2012-02-01 08:52:44 -08:00
Georg Brandl 1d8e6fd45e Fix #13900: resolve self-referential description of a parameter. 2012-01-29 15:38:47 +01:00
Benjamin Peterson 78028b0589 note that get() is not affected by default_factory (closes #13887) 2012-01-27 09:14:01 -05:00
Benjamin Peterson 0a15103d79 merge heads 2012-01-25 16:43:54 -05:00
Benjamin Peterson dcd37e8154 forgot to resolve this conflict... 2012-01-25 16:43:26 -05:00
Georg Brandl e9401a0476 #13852: some small doc fixes. 2012-01-25 22:36:25 +01:00
Benjamin Peterson af90a40445 kill extra word 2012-01-25 16:30:18 -05:00
Benjamin Peterson bcd6f3994c say bitwise (because I have no idea what a bit-string is) 2012-01-25 16:29:03 -05:00
Georg Brandl dfdc46f274 #13816: fix two minor style issues. Thanks to Justin Wehnes for the patch. 2012-01-23 20:19:33 +01:00
Antoine Pitrou 8fc732f088 Issue #12922: fix the TextIOBase documentation to include a description of seek() and tell() methods. 2012-01-21 20:27:59 +01:00
Ezio Melotti 51ab3519d8 Move a space. 2012-01-21 16:40:03 +02:00
Sandro Tosi 2d71e5c6b9 fix typo; thanks to Justin Watt from docs@ 2012-01-21 10:59:12 +01:00
Sandro Tosi cb21227407 Issue #13605: more meaningful example + fixes 2012-01-19 22:22:35 +01:00
Sandro Tosi 10f047dca8 Issue #13605: add documentation for nargs=argparse.REMAINDER 2012-01-19 21:59:34 +01:00
Meador Inge da747c3d97 Issue #2134: Clarify token.OP handling rationale in tokenize documentation. 2012-01-19 00:17:44 -06:00
Sandro Tosi 25e76bdb69 file.next() doc refers to itself 2012-01-17 18:57:30 +01:00
Ezio Melotti 8eab1fdc8b #13715: fix typo in unicodedata doc. Patch by Eli Collins. 2012-01-16 08:42:32 +02:00
Ezio Melotti 055d70d588 #13695: fix a couple of typos in the doc. 2012-01-16 08:21:24 +02:00
Sandro Tosi a76bb03c55 None is not a keyword, link file.next() to functions.html#next 2012-01-14 16:43:14 +01:00
Sandro Tosi 98ed08f24e update to new C roles and directives 2012-01-14 16:42:02 +01:00
Terry Jan Reedy 150122a5a2 #11633 about buffering of print 2012-01-14 00:06:37 -05:00
Terry Jan Reedy 4ba76b68b9 closes #13730 2012-01-13 23:41:31 -05:00
Antoine Pitrou 2d047e85b7 Merge 2012-01-12 08:09:15 +01:00
Antoine Pitrou d716c73d03 Issue #13724: improve documentation for socket.create_connection. 2012-01-12 08:06:19 +01:00
Terry Jan Reedy 1d79eb6abe Closes #13754 String returned if less than *or equal to* x 3 2012-01-11 03:19:28 -05:00
Senthil Kumaran 8070ddcd9b port to 2.7 - Issue9637 - Details that case of Proxy env var does not matter. 2012-01-11 01:35:02 +08:00
Raymond Hettinger a0ff91cac0 Fix stock symbol for Microsoft 2012-01-10 09:51:51 +00:00
Antoine Pitrou df4c986f9e Issue #13747: fix SSL compatibility table. 2012-01-09 21:43:18 +01:00
Antoine Pitrou 4a7e0c896c Issue #13747: fix documentation error about the default SSL version. 2012-01-09 21:35:11 +01:00
Sandro Tosi f788cf70f8 clarify recv* are blocking operations; thanks to Chris Kogelnik from docs@ 2012-01-07 17:56:43 +01:00
Raymond Hettinger 36cdca1277 Clarify that vars() doesn't place extra restrictions on __dict__. 2012-01-05 23:23:52 -08:00
Sandro Tosi 7f418f67a8 Issue #11984: remove reference to parser, it's not showing symbol usage anymore 2012-01-05 19:05:44 +01:00
Sandro Tosi 8b211fc123 Issue #10772: add count and help argparse action; patch by Marc Sibson 2012-01-04 23:24:48 +01:00
Sandro Tosi 499718de49 Issue #6031: improve serve_forever() description 2012-01-03 22:35:41 +01:00
Sandro Tosi 711f54798c Issue #9349: add argparse.SUPPRESS to help doc 2012-01-03 18:31:51 +01:00
Sandro Tosi e827c13566 Issue #13690: add re.DEBUG; patch by Filip Gruszczyński 2012-01-01 12:52:24 +01:00
Sandro Tosi 117e1f00a8 fix some broken URLs 2011-12-31 18:13:59 +01:00
Eli Bendersky 4b76f8a76c Some formatting & grammar fixes for the multiprocessing doc 2011-12-31 07:05:12 +02:00
Benjamin Peterson c016f46df5 use booleans 2011-12-30 13:47:25 -06:00
Sandro Tosi 44585bd347 fix "Title underline too short" sphinx warning 2011-12-25 17:13:10 +01:00
Sandro Tosi a4d06e7bc8 use double-quote char instead of unicode ones; thanks to tomo cocoa from docs@ 2011-12-25 17:05:30 +01:00
Sandro Tosi 4526273d7f fix to sent/send typo 2011-12-25 11:43:37 +01:00
Sandro Tosi dbcbd101e7 fix Constuctor/Constructor typo; thanks to Anthon van der Neut from docs@ 2011-12-25 11:27:22 +01:00
Sandro Tosi 4fbad84cb6 remove spurious dot from string formatting example; thanks to Anthon van der Neut from docs@ 2011-12-24 15:52:36 +01:00
Sandro Tosi 55ae12b019 correct syslog.openlog() argument name to logoption; thanks to Arnaud Gomes-do-Vale from docs@ 2011-12-24 14:51:26 +01:00
Senthil Kumaran 17fbe402d4 porting mimetype doc changes from 3.2. 
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 11:08:31 +08:00
Benjamin Peterson 587c7381c7 note the blinding speed of these functions 2011-12-20 10:12:41 -06:00
Benjamin Peterson 5879ca1fd9 don't mention implementation detail 2011-12-19 16:41:11 -05:00
Ezio Melotti d0ffcd601e #3932: suggest passing unicode to HTMLParser.feed(). 2011-12-19 07:15:26 +02:00
Ezio Melotti 080b6f071f #13387: rephrase unclear sentence. 2011-12-19 07:04:48 +02:00
Ezio Melotti 13c82d00c4 #13613: fix example in re doc. 2011-12-17 01:17:17 +02:00
Antoine Pitrou 22da68b1b0 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
Meador Inge 5295718399 Issue #13513: IOBase docs incorrectly link to the readline module 2011-12-03 12:13:42 -06:00
Ezio Melotti 2692be9d20 #13494: s/cast/convert/. Also add a link. 2011-12-02 19:47:24 +02:00
Ezio Melotti c2ed44f4f2 #13499: fix example adding >>> before the comments. 2011-12-02 19:26:48 +02:00
Vinay Sajip 3639807a79 Closes #13459: Clarified documentation on Logger.propagate. Thanks to Mike Fogel for the patch. 2011-11-23 08:51:35 +00:00
Raymond Hettinger 421467f8f0 Note the store_true and store_false also create the appropriate defaults. 2011-11-20 11:05:23 -08:00
Mark Dickinson b19284f6eb Issue #12245: Document sys.float_info.rounds better. 2011-11-19 16:26:08 +00:00
Ezio Melotti aa512f05a4 #13387: add note about checking the exact type in assertIsInstance doc. 2011-11-18 18:59:36 +02:00
Ezio Melotti ba41c6a1c3 #13426: fix typo in pickle doc. 2011-11-18 13:41:58 +02:00
Eli Bendersky 9efddb654b fixing typos in optparse doc 2011-11-16 06:01:14 +02:00
Eli Bendersky eb7113888e Normalize the keyword arguments documentation notation in re.rst. Closes issue #12875 2011-11-14 01:02:20 +02:00
Eli Bendersky 3a8501e71f Closes issue 12767: document the argument of threading.Condition.notify 2011-11-12 20:51:54 +02:00
Eli Bendersky a203cedf44 Issue #12875: explicitly specify default value of the optional 'flags' argument to re.* functions. Closes #12875 2011-11-11 21:25:56 +02:00
Eli Bendersky bba1dd5332 Issue #13191: typo in argparse docs 2011-11-11 16:42:11 +02:00
Vinay Sajip 5df091a91e Closes issue #13353: version doumentation about utc parameter corrected. 2011-11-06 22:37:17 +00:00
Éric Araujo 972ba9e41f Add missing versionadded (fixes #12392) 2011-11-05 17:55:03 +01:00
Petri Lehtinen 416ecffcc4 Issue #3067: Enhance the documentation and docstring of locale.setlocale() 2011-11-05 10:18:50 +02:00
Raymond Hettinger 5d19b9a1e8 Fix typos 2011-11-04 14:05:52 -07:00
Raymond Hettinger 23ca12a981 Inline the advisory text on how to use the shelve module. 2011-11-04 13:07:52 -07:00
Senthil Kumaran 0fc13ae345 Fix Issue13147 - Correct the Multiprocessing Pool.map_async method signature. 
Remove the error_callback which is not present in 2.7. Patch by Jyrki
Pulliainen.
 2011-11-03 02:02:38 +08:00
Ezio Melotti 7e82b276dd #670664: Fix HTMLParser to correctly handle the content of ``<script>...</script>`` and ``<style>...</style>``. 2011-11-01 14:09:56 +02:00
Sandro Tosi 1f3b84f971 correct signature for tzinfo.dst() in examples; thanks to Daniil Shved from docs@ 2011-11-01 10:31:26 +01:00
Sandro Tosi a9db763cc0 document turtle mainloop()/done() functions; thanks to Csaba Szepesvari from docs@ 2011-10-31 10:08:14 +01:00
Raymond Hettinger 187aa269c2 Improve itertools docs with clearer examples of pure python equivalent code. 2011-10-30 14:53:17 -07:00
Ezio Melotti 87033526ad Minor fixes to the HTMLParser doc. 2011-10-28 14:20:08 +03:00
Ezio Melotti f9cc80d601 Improve HTMLParser example in the doc. 2011-10-28 14:14:34 +03:00
Ezio Melotti 24c51809cf #13278: fix typo. 2011-10-28 12:22:25 +03:00
Nick Coghlan 87ba642ce6 Issue #13237: Make the subprocess convenience helper documentation self-contained aside from the shared parameter description. Downgrade the pipe warnings at that level to notes (since those pipes are hidden, people are unlikely to even try it) 2011-10-27 17:55:13 +10:00
Nick Coghlan 63c54e819e Issue #13237: fix typo 2011-10-26 21:34:26 +10:00
Nick Coghlan 65ad31a8f8 Issue #13237: remove some details that only apply to the 3.x version of this module and cross reference the relocated warning about the dangers of invoking the shell with untrusted input 2011-10-26 21:15:53 +10:00
Nick Coghlan 2ed203af87 Issue #13237: further updates to subprocess documentation 2011-10-26 21:05:56 +10:00
Ezio Melotti 59b13f4de9 Refactor a bit the codecs doc. 2011-10-25 10:46:22 +03:00
Benjamin Peterson 22dabb6ffa merge heads 2011-10-24 08:51:46 -04:00
Benjamin Peterson 414ffa86b5 note callable is back in 3.2 2011-10-24 08:51:15 -04:00
Nick Coghlan 8671157863 Issue #13237: Rearrange subprocess module documentation to emphasise the convenience functions and commonly needed arguments 2011-10-24 22:19:40 +10:00
Florent Xicluna df10d7cb97 Issue #13141: Demonstrate recommended style for SocketServer examples. 2011-10-23 23:07:22 +02:00
Éric Araujo b21f51a9d0 Note that the #1548891 fix indirectly fixes shlex (#6988, #1170) 2011-10-23 04:37:51 +02:00
Antoine Pitrou 5a77fe92bd Issue #1548891: The cStringIO.StringIO() constructor now encodes unicode 
arguments with the system default encoding just like the write() method
does, instead of converting it to a raw buffer.
 2011-10-22 21:26:01 +02:00
Ezio Melotti 5e30fa5f56 #13233: fix typo. 2011-10-20 19:49:29 +03:00
Ezio Melotti a1958734cb #13219: clarify section about character sets in the re documentation. 2011-10-20 19:31:08 +03:00
Senthil Kumaran ddd40312d5 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:38:35 +08:00
Ezio Melotti 1e87da16ea Remove duplication. 2011-10-19 10:39:35 +03:00
Ezio Melotti 086f927f25 #12277: add missing comma. 2011-10-18 13:02:11 +03:00
Ezio Melotti c54d97b961 #13138: add missing versionadded. Patch by Andreas Stührk. 2011-10-09 23:56:51 +03:00
Raymond Hettinger 3e0a3faaa2 Clean-up and improve the priority queue example in the heapq docs. 2011-10-09 17:32:43 +01:00
Éric Araujo eb35f25412 Fix a typo and a broken link (part of #10536). 
Found by Franz Glasner in #2504.
 2011-10-08 02:15:04 +02:00
Antoine Pitrou 5472c1c004 Issue #12823: remove broken link and replace it with another resource. 2011-10-07 17:03:01 +02:00
Éric Araujo e954ecb9ba Branch merge 2011-10-06 13:19:34 +02:00
Senthil Kumaran 41d663f0a5 Issue13073 - Address review comments and add versionchanged information in the docs. 2011-10-05 23:52:49 +08:00
Éric Araujo 2e4a2b6434 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 '2.7' is a CPython detail and
should not be advertised (see #9442), even if some stdlib modules
currently rely on that detail.
 2011-10-05 02:34:28 +02:00
Éric Araujo 656b04ecf6 Move doc of sys.dont_write_bytecode to make all attributes sorted again 2011-10-05 02:25:58 +02:00
Senthil Kumaran 83cc512a01 update 2.7 - Document message_body arg in HTTPConnection.endheaders 2011-10-03 07:37:58 +08:00
Ezio Melotti f17e405eb7 #13076: fix links to datetime.time. 2011-10-02 12:22:13 +03:00
Georg Brandl 607cc361bb Fix bug in heapq priority queue example. 2011-09-18 07:40:05 +02:00
Georg Brandl 21c69b1043 Add info from the docstring for random.gammavariate() to the docs. 2011-09-17 20:36:28 +02:00
Victor Stinner d99ff29cf9 Update sys.platform doc for #12326. 
Backport from Python 3.2 (e11b4c945f7e).
 2011-09-05 22:33:55 +02:00
Senthil Kumaran 9541f8eb2b merge from 3.2. 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:23:10 +08:00
Sandro Tosi a95d19efa6 #12781: Mention SO_REUSEADDR flag near socket examples 2011-09-02 20:04:20 +02:00
Éric Araujo b71c15d407 Branch merge 2011-09-02 17:33:10 +02:00
Éric Araujo cd90f79125 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 19:57:01 +02:00
Éric Araujo 7ce05e07c0 Fix some markup and one typo 2011-09-01 19:54:05 +02:00
Éric Araujo a7cbe28bcc Avoid using the default reST role. Makes Doc/tools/rstlint.py happy. 2011-09-01 19:49:31 +02:00
Ezio Melotti 4f14a1ff52 From RFC 3629 5- and 6-bytes UTF-8 sequences are invalid, so remove them from the doc. 2011-09-01 08:19:01 +03:00
Sandro Tosi 9bfc16a99e added versionadd information for pkgutil.get_data(); thanks to Kyle Monson from docs@ 2011-08-30 19:40:28 +02:00
Éric Araujo 0f697b300c Remove outdated pointer to optparse (fixes #11360). 
The doc already points to argparse.
 2011-08-26 16:38:40 +02:00
Antoine Pitrou b384356b9b 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:51:31 +02:00
Sandro Tosi 9b68092d1d #12787: link original MultiCall proposal to webarchive and in a footnote 2011-08-20 17:05:15 +02:00
Sandro Tosi a7eb3c802e fix description of \r; thanks to Thomas Waldmann from docs@ 2011-08-19 22:54:33 +02:00
Sandro Tosi da5a9622f1 merge heads 2011-08-19 18:43:43 +02:00
Sandro Tosi 657a7fcb95 mention RFC1123 as origin of 4-year digit; thanks to John Haxby from docs@ 2011-08-19 18:39:35 +02:00
Éric Araujo e0054c51c7 Link isinstance/issubclass to the ABC glossary entry (#12256) 2011-08-19 09:15:47 +02:00
Éric Araujo f06568cbd8 Fix a typo and remove some unneeded markup 2011-08-19 09:00:56 +02:00
Éric Araujo e68d4504fd Add documentation for PEP 370 features in distutils (#10745). 
Apart from adding a section to describe the user scheme, this changeset
also does some much needed cleanup:

- fixed inverted reST targets
- fixed some paths
- 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 does not use these files anymore since the Great Revert.
I suspect we have a mismatched stdlib at the moment, and the fix is not
even clear (see discussion on #8084).
 2011-08-19 08:34:52 +02:00
Éric Araujo afd2fe2aea 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 is also 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-19 08:20:01 +02:00
Éric Araujo 99c4c340e6 Add missing documentation for logger argument of shutil.make_archive 2011-08-19 02:51:17 +02:00
Éric Araujo bd858b75ce Turn last automatic footnote in this file into a manually-numbered one 2011-08-19 02:28:40 +02:00
Éric Araujo cdb86f17bf Branch merge 2011-08-19 02:26:44 +02:00
Éric Araujo 29a0b57e4e Backport source links from 3.x. 
Existing links have been updated to use the new reST role.  In some
files, I have also made cosmetic changes to the header.
 2011-08-19 02:14:03 +02:00
Éric Araujo d478a46d56 Use standard heading for ast module docs 2011-08-19 02:01:14 +02:00
Éric Araujo 67719bde07 Synchronize argparse docs with 3.x versions 2011-08-19 02:00:07 +02:00
Éric Araujo d9aeb60465 Remove unneeded reST target 2011-08-19 01:47:48 +02:00
Ezio Melotti 5085e8ac67 #12204: document that str.upper().isupper() might be False and add a note about cased characters. 2011-08-15 14:24:15 +03:00
Ezio Melotti ca5e908c6e #12725: fix working. Patch by Ben Hayden. 2011-08-14 08:27:36 +03:00
Éric Araujo 569ff91a5a Avoid title case in flowing text (backport from 3.2) 2011-08-13 02:47:38 +02:00
Sandro Tosi c67975beea it's 'rather than'; reported by James Bateman on docs@ 2011-08-12 19:31:15 +02:00
Sandro Tosi 71a5ea0a9b English fixup, from Mike MacCana on docs@ 2011-08-12 19:11:24 +02:00
Vinay Sajip 5088b504be Issue #12718: Add documentation on using custom importers. 2011-08-11 13:39:52 +01:00
Senthil Kumaran ea75f4cf3b Fix closes Issue12722 - link heapq source in the text format in the documentation. 2011-08-10 21:54:56 +08:00
Sandro Tosi a9c9b2c38c #12709: add error_callback argument to map_async documentation 2011-08-08 16:37:44 +02:00
Sandro Tosi 1381a31e39 #12677: correct turtle orientation in doc 2011-08-07 17:09:15 +02:00
Eli Bendersky e11af59e2a Fix grammar 2011-08-06 09:29:12 +03:00
Senthil Kumaran b8b71725c3 Fix closes Issue12697 - Update the usage syntax of timeit module in the docs. 2011-08-06 13:34:30 +08:00
Senthil Kumaran c1ee4ef9dc Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi. 2011-08-03 07:43:52 +08:00
Sandro Tosi 25fb852e55 #12670: Fix struct code after forward declaration on ctypes doc 2011-08-02 16:16:11 +02:00
Senthil Kumaran 22a7b488e0 Fix closes Issue12183 - Explain the Symlink copy behavior in shutil.copytree. Patch by Petri Lehtinen. 2011-08-02 18:50:44 +08:00
Georg Brandl 93d3a8d67c Use attribute access instead of index access for namedtuple. 2011-08-01 22:58:53 +02:00
Vinay Sajip 5d09ba46c9 Closes #12667: Corrected documentation for SMTPHandler secure argument. 2011-08-01 11:28:02 +01:00
Benjamin Peterson 35fd1b9107 be precise 2011-07-30 22:08:09 -05:00
Benjamin Peterson 110b781129 note Ellipsis syntax 2011-07-30 09:59:12 -05:00
Benjamin Peterson 6726af73de add space 2011-07-30 09:58:59 -05:00
Benjamin Peterson f444f94ed2 document NotImplemented 2011-07-30 09:57:24 -05:00
Eli Bendersky dedb502f90 Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen 2011-07-30 11:12:45 +03:00
Éric Araujo 43162e22c5 Document that atexit execution order is undefined (#9788) 2011-07-29 18:04:24 +02:00
Éric Araujo f0d44bccb7 Add a link target for argparse.Namespace (#8982) 2011-07-29 17:59:17 +02:00
Éric Araujo 345fff3de8 Remove mentions of previous license in profile module (#12417 followup) 2011-07-28 22:27:28 +02:00
Éric Araujo d01aebe3d6 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-29 12:10:53 +02:00
Éric Araujo 2e1c294d28 Fix “anyways” (following R. David Murray in 5c7520e02d5a) 2011-07-29 11:57:50 +02:00
Éric Araujo ad84ea11c2 Add links from builtins module docs to built-in functions and constants docs 2011-07-29 11:53:57 +02:00
Éric Araujo 5dd034b84f Minor doc addition for clarity 2011-05-27 04:42:47 +02:00
Éric Araujo 8fde9506b7 Improve glossary entry for ABCs. 
- Rename reST target name for collections ABCs to avoid collisions
- Link to glossary entry from numbers module doc (other modules already do it)
 2011-07-29 11:34:17 +02:00
Éric Araujo beb9170cc4 Merge #12417 followup, also removing an extra docstring 2011-07-28 22:32:04 +02:00
Ezio Melotti 8171cf52b6 #12642: fix args names in open() doc. 2011-07-27 08:48:52 +03:00
Ross Lagerwall 528c4adc0b Issue #12102: Document that buffered files must be flushed before being used 
with mmap. Patch by Steffen Daode Nurpmeso.
 2011-07-25 07:23:58 +02:00
Ezio Melotti b952413499 Fix markup. 2011-07-21 11:38:13 +03:00
Senthil Kumaran cd57ef1a47 merge from 3.2 - Fix closes issue12524 - update http.client POST example with a working example. - Patch contributed by Bharadwaj 2011-07-20 22:02:27 +08:00
Senthil Kumaran 60bf489e8a merge from 3.2 - Fix closes issue12577 - clarify shutil.move documentation. Patch suggestion by Catalin Iacob 2011-07-19 08:05:44 +08:00
Antoine Pitrou 711cb58db1 Issue #6476: Document that os.spawnle and os.spawnve are not thread-safe under Windows. 2011-07-19 01:26:58 +02:00
Senthil Kumaran 1c0ebc0fa5 fix whitespace in rst. 2011-07-18 07:18:40 +08:00
Senthil Kumaran a2dd57aaf1 merge from 3.2 - Fix closes Issue12478 - HTTPErrorProcess 's methods are http_response and https_response. 2011-07-18 07:16:02 +08:00
Senthil Kumaran 612b2b338b merge from 3.2 - Fix closes Issue12479 - Add HTTPErrorProcessor class definition - Patch by Sandro Tosi 2011-07-18 06:44:11 +08:00
Senthil Kumaran 4c9721ad40 merge from 3.2 - Issue10403 - datetime module documentation changes based on review. 2011-07-17 19:10:10 +08:00
Senthil Kumaran a09f13a0bc merge from 3.2. 2011-07-17 17:31:51 +08:00
Eli Bendersky 877f2e4530 Issue #12574: correct capitalization of the Queue module. Patch by Rafe Kettler 2011-07-17 05:54:06 +03:00
Raymond Hettinger cec795d639 It is really a suffix :-) 2011-07-14 14:41:43 +08:00
Ned Deily 0ab67ee79e 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:05:31 -07:00
Antoine Pitrou 0504532c39 Mention logging.captureWarnings in the warnings module doc. 2011-07-09 21:29:36 +02:00
Antoine Pitrou 73705902c4 Move sys.subversion at the right place in alphabetical order, 
and add a note concerning its status.
 2011-07-09 16:06:19 +02:00
Antoine Pitrou ea901ad2c6 Issue #12326: document the recommended idiom for checking sys.platform on Unix systems. 
Also, point to the various alternatives.
 2011-07-09 15:48:29 +02:00
Victor Stinner 8703be94b1 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:14:55 +02:00
Senthil Kumaran 6f18b98782 Fix closes issue10403 - Let's not use members anymore. 2011-07-04 12:50:02 -07:00
Senthil Kumaran e04d256c2d reST indentation fix in sqlite3 docs. rst uses 3 space indentation. 2011-07-03 10:12:59 -07:00
Ned Deily 43e1054e38 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-27 23:41:53 -07:00
Ezio Melotti 4601530137 #11363: add missing functions from curses doc. Patch by Sandro Tosi. 2011-06-26 13:34:56 +03:00
Ezio Melotti 14989cf4d1 #11363: clean up curses doc. 2011-06-26 13:33:46 +03:00
Senthil Kumaran 7bf5ba0f79 Fix Issue10020 - Doc update to sqlite3 module in 2.7 branch. 2011-06-25 20:48:21 -07:00
Ezio Melotti 196273e1d0 Use correct markup in zipimport.rst. Patch by Sara Magliacane. 2011-06-25 19:40:06 +03:00
Raymond Hettinger 320b91495a Issue 11889: Clarify docs for enumerate. 2011-06-25 14:57:06 +02:00
Mark Dickinson 653a53fb14 Issue #12228: Fix exchanged flag descriptions in stat.rst. Thanks Sandro Tosi. 2011-06-25 12:01:06 +02:00
R David Murray 17e2b40aae #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:19:25 -04:00
R David Murray 1d3365106d #12389: fix missing space at sentence end. 2011-06-22 20:00:27 -04:00
R David Murray 491eb6a17e #6771: fix docs: curses.wrapper is exposed as a function, not a module 
Patch by July Tikhonov.
 2011-06-18 19:31:22 -04:00