Commit Graph

2434 Commits

Author SHA1 Message Date
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