Commit Graph

4368 Commits

Author SHA1 Message Date
R David Murray 433ef3b5c3 #15694: reflow paragraph. 2012-08-17 20:39:21 -04:00
R David Murray 8eac575e81 Merge #15694: Link discussion of file objects to glossary entry.
This is analogous to the link for `flie objects` in the description of
'open' that exists in the 2.7 docs, and adds a similar link to the
io docs.

Patch by Chris Jerdonek.
2012-08-17 20:38:19 -04:00
R David Murray 9f0c9401d3 #15694: Link discussion of file objects to glossary entry.
This is analogous to the link for `flie objects` in the description of
'open' that exists in the 2.7 docs, and adds a similar link to the
io docs.

Patch by Chris Jerdonek.
2012-08-17 20:33:54 -04:00
Terry Jan Reedy bbfe573d9d Merge with 3.2 #15660 2012-08-17 15:42:12 -04:00
Terry Jan Reedy f6190c1463 Issue 15660: Clarify 0 prefix for width field in str.format doc. 2012-08-17 15:40:46 -04:00
Brett Cannon 1b79918641 Issue #15640: Document importlib.abc.Finder as deprecated.
The code for the class itself isn't deprecated for
backwards-compatibility reasons, but the class shouldn't be directly
inherited by anyone anymore as the API is no longer as widely valid as
it used to be.
2012-08-17 14:08:24 -04:00
Richard Oudkerk b391b24efe Merge 2012-08-17 15:05:09 +01:00
Richard Oudkerk d9c026fd77 Issue #15412: Remove erroneous note about weakrefs 2012-08-17 15:02:47 +01:00
Richard Oudkerk 67a58cc515 Merge 2012-08-17 14:42:43 +01:00
Richard Oudkerk 264e9ac5f5 Issue #14501: Clarify that authentication keys are byte strings 2012-08-17 14:39:18 +01:00
Antoine Pitrou d9a7e70939 Update the getpeercert() example with a real-world cert showing non-trivial issuer, subject and subjectAltName. 2012-08-16 22:18:37 +02:00
Antoine Pitrou b7c6c8105e Update the getpeercert() example with a real-world cert showing non-trivial issuer, subject and subjectAltName. 2012-08-16 22:14:43 +02:00
R David Murray 0689ce4396 #15543: reflow paragraph. 2012-08-15 11:13:31 -04:00
R David Murray 99d439afcf #15543: additional link in subprocess docs.
Patch by Chris Jerdonek.
2012-08-15 11:12:15 -04:00
R David Murray 27bbcfb8ff Merge #15543: glossary entry for and 'universal newlines', and links to it.
Patch by Chris Jerdonek.
2012-08-15 11:11:27 -04:00
R David Murray ee0a945ae4 #15543: reflow paragraphs. 2012-08-15 11:05:36 -04:00
R David Murray 1b00f25bf9 #15543: glossary entry for and 'universal newlines', and links to it.
Patch by Chris Jerdonek.
2012-08-15 10:43:58 -04:00
Eli Bendersky 3115f0d14b Issue #15586: typo fix. This commit is accompanied by an apology for all Liechtensteiners out there, and a thanks to Eric Araujo for noticing. 2012-08-15 14:26:30 +03:00
R David Murray 7f84833726 Merge #15269: document dircmp.left and right, and add tests for them.
Patch by Chris Jerdonek.
2012-08-14 21:45:25 -04:00
R David Murray 2b209cd78d #15269: document dircmp.left and right, and add tests for them.
Patch by Chris Jerdonek.
2012-08-14 21:40:13 -04:00
Georg Brandl e471772fff Review of signature docs. 2012-08-14 09:45:28 +02:00
Georg Brandl 1487c931cb merge with 3.2 2012-08-14 09:40:26 +02:00
Georg Brandl 296d1bea6a Restore original line lengths. 2012-08-14 09:39:07 +02:00
Eli Bendersky 0f4e934174 Issue #15586: add some examples to ElementTree documentation. Patch by Daniel Ellis. 2012-08-14 07:19:33 +03:00
Andrew Svetlov f334f740e4 Issue #15497: Correct characters in TextWrapper.replace_whitespace docs.
Patch by Chris Jerdonek.
2012-08-13 23:23:02 +03:00
Andrew Svetlov 59db401667 Issue #15497: Correct characters in TextWrapper.replace_whitespace docs.
Patch by Chris Jerdonek.
2012-08-13 23:22:23 +03:00
Andrew Svetlov a86565465a Push importlib ABC hierarchy chart. 2012-08-13 22:19:01 +03:00
Andrew Svetlov 4805fa862e Issue #15561: Update subprocess docs to reference io.TextIOWrapper.
Patch by Chris Jerdonek.
2012-08-13 22:11:14 +03:00
Andrew Svetlov 50be452e0f Issue #15561: Update subprocess docs to reference io.TextIOWrapper.
Patch by Chris Jerdonek.
2012-08-13 22:09:04 +03:00
Andrew Svetlov eed1808dec Minor update of docs for inspect module. 2012-08-13 18:23:54 +03:00
Andrew Svetlov 4e48bf929b Issue #15151: PEP 362 — document signature and related classes for inspect.py
Initial patch by Yury Selivanov
2012-08-13 17:10:28 +03:00
Andrew Svetlov e4b1a189a7 Issue #15624: clarify newline documentation for open and io.TextIOWrapper
Thanks to Chris Jerdonek
2012-08-13 12:59:00 +03:00
Andrew Svetlov ecd78feb78 Issue #15624: clarify newline documentation for open and io.TextIOWrapper
Thanks to Chris Jerdonek
2012-08-13 12:58:02 +03:00
Sandro Tosi 2e64a0b6ff merge with 3.2 2012-08-12 17:34:13 +02:00
Sandro Tosi c7b0e217e2 add usage example from cli; thanks to Christian Clauss from docs@ 2012-08-12 17:34:00 +02:00
Sandro Tosi c254f640a7 merge with 3.2 2012-08-12 15:35:43 +02:00
Sandro Tosi 6cbe405a20 escape '\'; thanks to Steve Holden from docs@ 2012-08-12 15:35:25 +02:00
Sandro Tosi 5bb665f00c merge with 3.2 2012-08-12 15:12:32 +02:00
Sandro Tosi 985104a20c it's getstatus() not setstatus(); thanks to Shaddi Hasan from docs@ 2012-08-12 15:12:15 +02:00
Andrew Svetlov 439e17fb0b update doctests 2012-08-12 15:16:42 +03:00
Andrew Svetlov 199b78d41a fix doctest for email.header docs 2012-08-12 14:49:59 +03:00
Sandro Tosi 5a5e8dd931 merge with 3.2 2012-08-12 12:35:31 +02:00
Sandro Tosi 82a509ca75 add missing quote in splitlines() example; thanks to Yevgen Yampolskiy from docs@ 2012-08-12 12:35:14 +02:00
Sandro Tosi effb43bc38 merge with 3.2 2012-08-12 10:49:40 +02:00
Sandro Tosi ee903c5125 add missing parenthesis to 'action' argparse doc; thanks to kishkin from docs@ 2012-08-12 10:49:26 +02:00
Sandro Tosi ea47530e14 update CodeTools link; thanks to Robert Kern from docs@ 2012-08-12 10:37:23 +02:00
Brett Cannon a6e8581449 Minor doc formatting cleanup. 2012-08-11 19:41:27 -04:00
Andrew Svetlov a2fe334081 Issue #15527: fix docs, remove double parens by changing markup.
Patch by Serhiy Storchaka.
2012-08-11 21:14:08 +03:00
Antoine Pitrou b79be95dac Issue #15444: Use proper spelling for non-ASCII contributor names.
Patch by Serhiy Storchaka.
2012-08-11 16:54:27 +02:00
Antoine Pitrou fbd4f80979 Issue #15444: Use proper spelling for non-ASCII contributor names.
Patch by Serhiy Storchaka.
2012-08-11 16:51:50 +02:00
Brett Cannon ac9f2f3de3 Issue #15576: Allow extension modules to be a package's __init__
module again. Also took the opportunity to stop accidentally exporting
_imp.extension_suffixes() as public.
2012-08-10 13:47:54 -04:00
Brett Cannon f4dc9204cc Issue #15502: Finish bringing importlib.abc in line with the current
state of the import system. Also make importlib.invalidate_caches()
work with sys.meta_path instead of sys.path_importer_cache to
completely separate the path-based import system from the overall
import system.

Patch by Eric Snow.
2012-08-10 12:21:12 -04:00
Andrew Svetlov eec6420de4 Issue #15501: Document exception classes in subprocess module.
Initial patch by Anton Barkovsky.
2012-08-09 15:20:45 +03:00
Andrew Svetlov b4a09abfce Issue #15501: Document exception classes in subprocess module.
Initial patch by Anton Barkovsky.
2012-08-09 15:11:45 +03:00
Andrew Svetlov e939f383c1 Fix documentation for inspect module to pass doctest 2012-08-09 13:25:32 +03:00
Brett Cannon cb4996afe4 Issue #15471: Don't use mutable object as default values for the
parameters of importlib.__import__().
2012-08-06 16:34:44 -04:00
R David Murray 638de338e6 Merge #15554: clarify splitlines/split differences.
Patch by Chris Jerdonek.
2012-08-06 16:08:40 -04:00
R David Murray 05c35a6a6b #15554: clarify splitlines/split differences.
Patch by Chris Jerdonek.
2012-08-06 16:08:09 -04:00
Brett Cannon 222d473df4 Issue #15482: Merge 78449:3fe01f7520e2 with a minor clarification. 2012-08-05 20:49:53 -04:00
Brett Cannon 9b000e7a68 Issue #15482: Properly document the default 'level' parameter for
__import__().

To help explain why the -1 default value is typically not seen, a note
about how import statements only use values of >= 0 is also noted.
2012-08-05 20:46:25 -04:00
Victor Stinner 62bb394729 Close #13072: Restore code before the PEP 393 for the array module
'u' format of the array module uses again Py_UNICODE type for backward
compatibility with Python 3.2.

The only change from Python 3.2 is that PyUnicode_AsUnicode() result is now
checked for NULL value.
2012-08-06 00:46:05 +02:00
Victor Stinner 69a6ca5260 os.unlinkat() has been removed, update os.fwalk() doc 2012-08-05 15:18:02 +02:00
Nick Coghlan 31096a94e7 Issue #14814: Attempt to clarify network address and broadcast address for less experienced users 2012-08-05 22:52:38 +10:00
Nick Coghlan 7362c3efeb Issue #14814: Finish review of ipaddress network object docs (initial patch was by Eli Bendersky) 2012-08-05 22:32:37 +10:00
Nick Coghlan 730f67f2fa Issue 14814: Docs work showed some more cases of networks pretending to be addresses and highlighted the weird approach to implementing the 'is_whatever' properties. Impl now illustrates far more clearly that networks have a property if both their network and broadcast addresses have that property 2012-08-05 22:02:18 +10:00
Victor Stinner 15f3d1e266 Issue #12655: Mention multiprocessing.cpu_count() in os.sched_getaffinity() doc 2012-08-04 20:57:48 +02:00
Antoine Pitrou 848698727f Issue #12655: Instead of requiring a custom type, os.sched_getaffinity and
os.sched_setaffinity now use regular sets of integers to represent the
CPUs a process is restricted to.
2012-08-04 16:16:35 +02:00
Victor Stinner d1f9352bd4 (Merge 3.2) open() / TextIOWrapper doc: make it explicit than newline='\n'
doesn't translate newlines on output.
2012-08-04 01:22:07 +02:00
Victor Stinner 401e17d0f0 open() / TextIOWrapper doc: make it explicit than newline='\n' doesn't
translate newlines on output.
2012-08-04 01:18:56 +02:00
Antoine Pitrou 3c25dfbf13 Make TextIOWrapper's documentation clearer by copying the newline argument's description from open(). 2012-08-04 00:56:19 +02:00
Antoine Pitrou 0c1c0d42dc Make TextIOWrapper's documentation clearer by copying the newline argument's description from open(). 2012-08-04 00:55:38 +02:00
Brett Cannon 077ef45a74 Update the What's New details for importlib based on doc/ABC changes. 2012-08-02 17:50:06 -04:00
Brett Cannon 773468f3a9 Ditch the 'self' argument in importlib docs since it's implied. 2012-08-02 17:35:34 -04:00
Nick Coghlan 4941774f59 Issue #15502: Bring the importlib.PathFinder docs and docstring more in line with the new import system documentation, and fix various parts of the new docs that weren't quite right given PEP 420 or were otherwise a bit misleading. Also note the key terminology problem still being discussed in the issue 2012-08-02 23:03:58 +10:00
Nick Coghlan ff79486bb5 Close #15519: Properly expose WindowsRegistryFinder in importlib and bring the name into line with normal import terminology. Original patch by Eric Snow 2012-08-02 21:45:24 +10:00
Nick Coghlan 8a9080feff Issue #15502: Bring the importlib ABCs into line with the current state of the import protocols given PEP 420. Original patch by Eric Snow. 2012-08-02 21:26:03 +10:00
Barry Warsaw 9a5af1288d merge 2012-07-31 16:03:25 -04:00
Eli Bendersky 0e49749f31 Issue #14814: reorganize ipaddress documentation and document all attributes of IPv[46]Address objects 2012-07-31 17:23:11 +03:00
Victor Stinner 1713f9ae5e Update the string limit in the faulthandler documentations 2012-07-31 03:25:28 +02:00
Brett Cannon 60622ed12a Minor markup tweak. 2012-07-30 19:31:00 -04:00
Brett Cannon 73df364ee6 Add a versionchanged mention to __import__ in regards to negative level values. 2012-07-30 18:35:17 -04:00
Barry Warsaw d7d2194ea1 Integration of importdocs from the features/pep-420 repo. 2012-07-29 16:36:17 -04:00
Andrew Svetlov 69f343941f Issue #15041: update "see also" list in tkinter documentation. 2012-07-26 17:16:24 +03:00
Andrew Svetlov e708a8a4aa Issue #15041: update "see also" list in tkinter documentation. 2012-07-26 17:02:57 +03:00
Antoine Pitrou c5618f039d Mention the *limit* argument of TextIO.readline(). 2012-07-25 22:40:05 +02:00
Antoine Pitrou 707bd4e385 Mention the *limit* argument of TextIO.readline(). 2012-07-25 22:38:33 +02:00
Vinay Sajip f7dbb0f64e Closes #15445: Merged documentation update from 3.2. 2012-07-25 19:20:32 +01:00
Vinay Sajip 393e23fbb5 Issue #15445: Updated logging configuration documentation to highlight potential security risk posed by listen() in certain scenarios. 2012-07-25 19:19:25 +01:00
Eli Bendersky f7a54a0f12 Cleanup the doc a bit: remove useless example and sentence 2012-07-24 20:44:48 +03:00
Eli Bendersky e431ed2354 Clarify what happens if shallow is false. Also, the caching note is not really correct since the cache gets occasionally cleared; therefore I removed it. 2012-07-24 19:47:34 +03:00
Senthil Kumaran d74062948d - Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch contributed by Chris Jerdonek. 2012-07-22 19:31:36 -07:00
Senthil Kumaran 28a9f2193a - Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch contributed by Chris Jerdonek. 2012-07-22 19:12:58 -07:00
R David Murray 4fb6b0a104 Merge #15429: Fix invalid mention of types.NoneType from None docs. 2012-07-22 20:43:42 -04:00
R David Murray e60e12b57a #15429: Fix invalid mention of types.NoneType from None docs. 2012-07-22 20:43:13 -04:00
Meador Inge 5116704ec5 Issue #15410: Fix the urllib.request.Request.is_unverifiable deprecation documentation. 2012-07-20 19:50:41 -05:00
Vinay Sajip 5e1658c5d7 Closes #15399: merged documentation fix from 3.2. 2012-07-20 09:51:20 +01:00
Vinay Sajip 3be7a8bbcf Issue #15399: Added versionchanged for processName. 2012-07-20 09:50:18 +01:00
Hynek Schlawack 26fe37dd3f #1492704: Backout and wait for 3.4 2012-07-19 21:41:02 +02:00
Hynek Schlawack 77d3283370 #1492704: Make shutil.copyfile() raise a distinct SameFileError
Patch by Atsuo Ishimoto.
2012-07-19 20:23:49 +02:00
Nick Coghlan c5afd42df8 Fix importlib.machinery.all_suffixes docs 2012-07-18 23:59:08 +10:00
Nick Coghlan 76e077001d Close #15387: inspect.getmodulename() now uses a new importlib.machinery.all_suffixes() API rather than the deprecated inspect.getmoduleinfo() 2012-07-18 23:14:57 +10:00
Vinay Sajip 90db661b43 Closes #15307: symlinks now work on OS X with framework Python builds. Patch by Ronald Oussoren. 2012-07-17 17:33:46 +01:00
Raymond Hettinger b22ba046ae Fix typo 2012-07-16 02:07:41 -07:00
Raymond Hettinger b2269baca3 Clean-up example 2012-07-15 23:53:32 -07:00
Raymond Hettinger 2a61c451f2 cm.parents is property, not a method 2012-07-15 22:37:20 -07:00
Larry Hastings 950b76ab1a Doc fix: the text role is called "func", not "funk". 2012-07-15 17:32:36 -07:00
Larry Hastings 7aa2c8baae Issue #15202: Additional documentation fixes inadvertently omitted
from previous checkin.
2012-07-15 16:58:29 -07:00
Larry Hastings b40380667c Issue #15202: Consistently use the name "follow_symlinks" for
new parameters in os and shutil functions.  Patch by Serhiy Storchaka.
2012-07-15 10:57:38 -07:00
Nick Coghlan 8ecf50474c Issue #15343: Handle importlib.machinery.FileFinder instances in pkgutil.walk_packages (et al) 2012-07-15 21:19:18 +10:00
Nick Coghlan 85e729ec3b Take the first step in resolving the messy pkgutil vs importlib edge cases by basing pkgutil explicitly on importlib, deprecating its internal import emulation and setting __main__.__loader__ correctly so that runpy still works (Affects #15343, #15314, #15357) 2012-07-15 18:09:52 +10:00
Eli Bendersky f96cf911a0 Issue #9458: clarify the documentation of ElementTree.write with regards to the type of the stream expected for a given encoding 2012-07-15 06:19:44 +03:00
Eli Bendersky 00f402bfcb Close #1767933: Badly formed XML using etree and utf-16. Patch by Serhiy Storchaka, with some minor fixes by me 2012-07-15 06:02:22 +03:00
Larry Hastings 1191709b13 - Issue #15233: Python now guarantees that callables registered with
the atexit module will be called in a deterministic order.
2012-07-14 18:20:37 -07:00
Larry Hastings ad5ae0456e - Issue #15238: shutil.copystat now copies Linux "extended attributes". 2012-07-14 17:55:11 -07:00
Brett Cannon 15810673dc Minor grammatical tweaks. 2012-07-14 14:30:48 -04:00
Eli Bendersky f877a7cce1 Some small fixes and clarifications to the io documentation 2012-07-14 21:22:25 +03:00
Nick Coghlan 24711c4fac Merge #15230 doc updates from 3.2 2012-07-15 00:38:43 +10:00
Nick Coghlan a3d1cac4b2 Issue #15230: Update runpy docs to clarify a couple of points that came up in this issue 2012-07-15 00:36:39 +10:00
Brett Cannon d104eef118 Issue #15053: Make sure all functions related to the import lock have
the Python 3.3 change notice on them in case someone directly links to
the function(s).
2012-07-13 11:26:19 -04:00
Antoine Pitrou 52cc722ab8 Add c_size_t and c_ssize_t to the ctypes summary table. 2012-07-12 20:31:50 +02:00
Raymond Hettinger 921d1244c6 Show the proper way to exit a cmd shell 2012-07-12 11:26:01 -07:00
Eli Bendersky 78da3bc0af Additional fixes to multiprocessing docs (for issue #13686) 2012-07-13 10:10:05 +03:00
Eli Bendersky 8a80502d2c Issue #15296: Fix minidom.toxml/toprettyxml for non-unicode encodings. Patch by Serhiy Storchaka, with some minor style adjustments by me. 2012-07-13 09:52:39 +03:00
Eli Bendersky b674dcf53e Some fixes for the documentation of multiprocessing (per issue #13686) 2012-07-13 09:45:31 +03:00
Eli Bendersky e08824c300 Remove :noindex: for threading.Thread which killed all reference links to it 2012-07-13 09:01:57 +03:00
Antoine Pitrou c128167318 Add c_size_t and c_ssize_t to the ctypes summary table. 2012-07-12 20:32:11 +02:00
Raymond Hettinger 77f7a9bcc9 merge 2012-07-12 11:26:56 -07:00
Vinay Sajip c4618e33b2 Factored out common venv documentation and added more information about Distribute/pip. 2012-07-10 08:21:07 +01:00
Raymond Hettinger f07d949367 Fix markup 2012-07-09 12:43:57 -07:00
Brett Cannon 5c453ce3a4 Use the proper term. 2012-07-09 14:40:38 -04:00
Brett Cannon b19449751f Issue #15288: Clarify that pkgutil.walk_packages() and friends will no
longer work as expected in Python 3.3 as importlib's loaders do not
implement the non-standard iter_modules() method. Also link to the
term "loader" in the requisite notes to help make it clearer what has
happened.
2012-07-09 14:10:23 -04:00
Brett Cannon 19a2f5961c Issue #15056: imp.cache_from_source() and source_from_cache() raise
NotimplementedError when sys.implementation.cache_tag is None.

Thanks to Pranav Ravichandran for taking an initial stab at the patch.
2012-07-09 13:58:07 -04:00
Vinay Sajip cd9b746b37 Added cross-references to venv definition. 2012-07-09 10:37:01 +01:00
Vinay Sajip a945ad1a12 Issue #15283: Updated pyvenv documentation to expand on activation. 2012-07-09 09:24:59 +01:00
Raymond Hettinger 9ae9473389 Make it easier to search for the grouper() recipe. 2012-07-08 16:04:03 -07:00
Raymond Hettinger 86a20f834a Issue 15265: document the exception raised for invalid sample sizes. 2012-07-08 16:01:53 -07:00
Terry Jan Reedy dd445e8ece Merge 3.2 closes issue 13557 2012-07-08 17:52:58 -04:00
Terry Jan Reedy 83efd6cbb6 Issue #13557: Clarify effect of giving two different namespaces to exec or
execfile().
2012-07-08 17:36:14 -04:00
Senthil Kumaran ac3f4f3133 Fix markup for versionchanged sphinx directive. 2012-07-08 01:32:57 -07:00
Senthil Kumaran a5e0eaf2e1 Fix 5931 - Python runtime hardcoded in wsgiref.simple_server - Now it specifies an implementation specific term. 2012-07-07 14:29:58 -07:00
Florent Xicluna 109d57358e Issue #13248: io: Remove obsolete argument "max_buffer_size" of BufferedWriter and BufferedRWPair. 2012-07-07 17:03:22 +02:00
Richard Oudkerk 2240ac1eae Issue #15261: Stop os.stat(fd) crashing on Windows when fd not open. 2012-07-06 12:05:32 +01:00
Vinay Sajip abd344cbab Issue 15241: Improved site.py documentation relating to venvs. 2012-07-03 16:33:57 +01:00
Brett Cannon 1e331560ee Closes #15030: Make importlib.abc.PyPycLoader respect the new .pyc
file size header field.

Thanks to Marc Abramowitz and Ronan Lamy for helping out with various
parts of the patch.
2012-07-02 14:35:34 -04:00
Georg Brandl c9d2fc390d Merge with 3.2. 2012-07-01 09:56:07 +02:00
Georg Brandl 29feb1ffca Make call of os.getppid() conditional: it is not available on Windows. 2012-07-01 09:47:54 +02:00
Senthil Kumaran 0b50bf3ffc urlparse docs clean up - no reference to earlier draft 2012-06-28 21:08:27 -07:00
Senthil Kumaran 4a27d9fb46 urlparse docs clean up - no reference to earlier draft 2012-06-28 21:07:58 -07:00
Antoine Pitrou 802d669044 Issue #5067: improve some json error messages.
Patch by Serhiy Storchaka.
2012-06-29 01:59:54 +02:00
Antoine Pitrou 2d24e94bbe Issue #5067: improve some json error messages.
Patch by Serhiy Storchaka.
2012-06-29 01:58:26 +02:00
Hynek Schlawack 5d2ecfb780 Fix typo in shutil doc 2012-06-27 17:53:22 +02:00
Senthil Kumaran 13c668229c issue13666 - merge from 3.2 2012-06-26 20:01:06 +08:00
Senthil Kumaran 72a80e85a8 issue13666 - Fixing datetime documentation example when using tzinfo 2012-06-26 20:00:15 +08:00
Georg Brandl ee0be40f29 Add yet another missing versionchanged. 2012-06-26 09:14:40 +02:00
Georg Brandl 9aae9e5e6b Fix a few markup nits in zlib docs and add missing versionchanged tags. 2012-06-26 08:51:17 +02:00
Senthil Kumaran 93e3d3ac09 merge from 3.2 - Issue13685 2012-06-26 14:18:19 +08:00
Senthil Kumaran f21804ad61 Issue #13685 - Update argparse help message for % sign usage. 2012-06-26 14:17:19 +08:00
Larry Hastings c48fe98a7c Issue #15177: Added dir_fd parameter to os.fwalk(). 2012-06-25 04:49:05 -07:00
Larry Hastings fdaea06d3c Issue #15176: Clarified behavior, documentation, and implementation
of os.listdir().
2012-06-25 04:42:23 -07:00
Larry Hastings 77892dc1e3 More doc fixes: made it clear where to start reading when you click on <dir_fd>. 2012-06-25 03:27:33 -07:00
Georg Brandl aceaf90804 Some tightening of the documentation for the new kwarg-style os module functionality. 2012-06-25 08:33:56 +02:00
Larry Hastings 48986d68c2 Minor grammar refinement for hmac.compare_digest(). 2012-06-25 00:59:34 -07:00
Georg Brandl 4d399a4092 Grammar fix. 2012-06-25 07:40:32 +02:00
Larry Hastings 68386bc0b8 Issue #15164: Change return value of platform.uname() from a
plain tuple to a collections.namedtuple.
2012-06-24 14:30:41 -07:00
Georg Brandl 61063cca6a Fix a couple of versionadded/versionchanged related markup errors. 2012-06-24 22:48:30 +02:00
Georg Brandl 33369cf9a5 Fix a bunch of "versionchanged" related markup errors. 2012-06-24 22:48:03 +02:00
Georg Brandl 217aa554fa Fix markup, for real this time. 2012-06-24 22:26:21 +02:00
Éric Araujo b0f0895849 Fix indentation 2012-06-24 16:22:09 -04:00
Ezio Melotti 46495182d0 #15156: HTMLParser now uses the new "html.entities.html5" dictionary. 2012-06-24 22:02:56 +02:00
Éric Araujo 56261cff16 Branch merge 2012-06-24 13:54:22 -04:00
Éric Araujo 544e13d126 Fix markup 2012-06-24 13:53:48 -04:00
Éric Araujo 0a8f5f709a Fix typos 2012-06-24 13:53:41 -04:00
Georg Brandl 19c4e5bb39 Fix test__locale on Mac; platform.uname() does not have a structseq-type interface (yet). 2012-06-24 19:29:49 +02:00
Georg Brandl 03b9ad05d6 Add a single versionadded for a whole section instead of repeating for every function. 2012-06-24 18:09:40 +02:00
Georg Brandl 96acb73dd5 Small whitespace fixes for shutil.rmtree() docs. 2012-06-24 17:39:05 +02:00
Georg Brandl 4a7e25f4df #444582: fix example and rewrap docs a bit. 2012-06-24 17:37:07 +02:00
Georg Brandl dbab58fdeb Refactor the venv API docs into a real API doc style. 2012-06-24 16:37:59 +02:00
Antoine Pitrou 5f762af3bc Remove a detailed discussion of content-based short circuiting, off topic for library docs. 2012-06-24 16:23:54 +02:00
Antoine Pitrou f61e7910ea Simplify wording. 2012-06-24 16:21:10 +02:00
Antoine Pitrou 1524d7556d Formatting 2012-06-24 16:18:48 +02:00
Hynek Schlawack 1729b8f45b Fix doc of os.fwalk: example used now non-existing os.fstatat() 2012-06-24 16:11:08 +02:00
Georg Brandl ae64b4d8e2 Merge heads. 2012-06-24 16:11:23 +02:00
Georg Brandl 3b44d81cf9 Merge heads. 2012-06-24 16:10:47 +02:00
Georg Brandl a1bc35f07f Improve hmac.compare_digest() docstring and documentation, courtesy of Larry H. 2012-06-24 16:07:33 +02:00
Antoine Pitrou 4f9946874b The buffer protocol doesn't exist (in the glossary anyway). 2012-06-24 16:04:38 +02:00
Antoine Pitrou 9df73dac84 Larry's suggested rewording of the compare_digest() docs. 2012-06-24 16:03:50 +02:00
Georg Brandl 6cff9ffab0 Fix use of class markup. 2012-06-24 14:05:40 +02:00
Christian Heimes 6cea65555c Issue #15061: Re-implemented hmac.compare_digest() in C 2012-06-24 13:48:32 +02:00
Larry Hastings 605a62ddb1 Issue #15118: Change return value of os.uname() and os.times() from
plain tuples to immutable iterable objects with named attributes
(structseq objects).
2012-06-24 04:33:36 -07:00
Georg Brandl f62445ad30 Fix casing of Unix. 2012-06-24 13:31:20 +02:00
Georg Brandl 8a5555f792 Make the style of the "Availability" sections consistent. 2012-06-24 13:29:09 +02:00
Georg Brandl a570e98e7b Actually it is just one function. 2012-06-24 13:26:22 +02:00
Georg Brandl b2462e2b8c Minor clarification about fdopen(). 2012-06-24 13:24:56 +02:00
Georg Brandl b8f2d29ea9 Remove attribution; this is for the whatsnew. 2012-06-24 13:06:44 +02:00
Georg Brandl 306336bcda Closes #15161: add support for giving path as a fd for truncate() and pathconf(). 2012-06-24 12:55:33 +02:00
Georg Brandl 8ccadaafe6 Restore mostly-alphabetic sorting of os functions. 2012-06-24 12:50:06 +02:00
Georg Brandl b9df00cc00 Note that equivalents are valid for 3.3+ only. 2012-06-24 12:38:14 +02:00
Georg Brandl b9831ab63c Move Linux-only *xattr() functions to their own subheading. 2012-06-24 11:57:07 +02:00
Georg Brandl 7ac2af78a2 Fix typo. 2012-06-24 11:56:47 +02:00
Georg Brandl b1a1ac0b67 Small nits in os doc. 2012-06-24 11:54:07 +02:00
Georg Brandl 50c4000685 "Refactor" docs for the new dir_fd, follow_symlinks, path-as-fd APIs: document the options at a central place and link to it. 2012-06-24 11:45:20 +02:00
R David Murray 97f43c019f #15160: Extend the new email parser to handle MIME headers.
This code passes all the same tests that the existing RFC mime header
parser passes, plus a bunch of additional ones.

There are a couple of commented out tests where there are issues with the
folding.  The folding doesn't normally get invoked for headers parsed from
source, and the cases are marginal anyway (headers with invalid binary data)
so I'm not worried about them, but will fix them after the beta.

There are things that can be done to make this API even more convenient, but I
think this is a solid foundation worth having.  And the parser is a full RFC
parser, so it handles cases that the current parser doesn't.  (There are also
probably cases where it fails when the current parser doesn't, but I haven't
found them yet ;)

Oh, yeah, and there are some really ugly bits in the parser for handling some
'postel' cases that are unfortunately common.

I hope/plan to to eventually refactor a lot of the code in the parser which
should reduce the line count...but there is no escaping the fact that the
error recovery is welter of special cases.
2012-06-24 05:03:27 -04:00
Sandro Tosi 27b130e702 Issue #15060: better fix, thanks to review on #python-dev 2012-06-14 00:37:09 +02:00
Sandro Tosi 56692f5722 Issue #15060: fix typo in socket doc; Patch by anatoly techtonik 2012-06-13 23:58:54 +02:00
Sandro Tosi 964f205a34 refer to time.strftime 2012-06-02 18:22:02 +02:00
R David Murray 554b3481fa #14957: fix doc typo. 2012-06-02 11:20:29 -04:00
R David Murray ae1b94b6e4 #14957: clarify splitlines docs.
Initial patch by Michael Driscoll, I added the example.
2012-06-01 16:19:36 -04:00
Sandro Tosi 3f7d1d3303 Issue #14968: set 'Inplace Operators' as subsection; patch by Lars Buitinck 2012-06-01 20:23:20 +02:00
Brian Curtin 13c70345ca Fix #14943. Update the proper default value and list the proper argument names in the explanation. 2012-05-29 18:34:45 -05:00
R David Murray e1398f77ea #11785: fix the :mod: references in email package submodule titles. 2012-05-27 17:17:53 -04:00
Petri Lehtinen 1a01ebc41c #14863: Update the documentation of os.fdopen()
There's no bufsize argument anymore, and os.fdopen() is only a very
thin wrapper around open() anymore. Change the documentation to
reflect that.
2012-05-24 21:46:36 +03:00
Hynek Schlawack 979f37afd2 Restore [] where default arguments are not keywords
Reverts some changes of d13fdd97cc8e.
2012-05-22 16:12:18 +02:00
Hynek Schlawack dfa465243c #14804: Remove [] around optional arguments with default values 2012-05-21 11:01:54 +02:00
Hynek Schlawack f54c0604c8 Fix `versionchanged` tags for json.load
`versionchanged` tags about 2.7 are useless in 3.x branches.
2012-05-20 18:32:53 +02:00
Vinay Sajip 69d8493899 Fixes #14864: Added documentation on how to undo the effects of a logging.disable() call. 2012-05-20 15:36:17 +01:00
Hynek Schlawack 1203e83d28 Document when json.load's parse_constant behaviour changed
It doesn't get called on 'null', 'true', 'false' since f686aced02a3.
2012-05-20 12:03:17 +02:00
Petri Lehtinen 079bfc962d #14494: Document that absolute imports became default in 3.0 instead of 2.7. 2012-05-19 18:36:33 +03:00
Petri Lehtinen 1033b310a3 Fix time.time() references in the time module docs
Closes #14842.
2012-05-18 21:22:47 +03:00
R David Murray f7a6615719 #14823: Simplify threading.Lock.acquire argument discussion. 2012-05-17 09:13:30 -04:00
Hynek Schlawack 9729fd4427 #14692 Fix json docs to reflect changes in json.load
The behaviour of the parse_constant callback changed insofar that 'null',
'true', 'false' don't trigger its call anymore.

Patch by Serhiy Storchaka
2012-05-16 19:01:04 +02:00
R David Murray 28e68ea6ea #1440472: reflow 2012-05-15 22:13:29 -04:00
R David Murray ea1badbfef #1440472: Explain that email parser/generator isn't *quite* "idempotent" 2012-05-15 22:07:52 -04:00
R David Murray 539f239e88 #14766: Reflow the altered paragraphs. 2012-05-14 22:17:23 -04:00
R David Murray 9075d8b771 #14766: Add correct algorithm for when a 'time' object is naive.
This patch also clarifies the definition of Naive and Aware.

Original patch by Greg Weller, I modified the first hunk
somewhat to make the exposition even clearer (I hope).
2012-05-14 22:14:46 -04:00
Sandro Tosi 3918b1ebfb Issue #14793: fix grammar in bytes object paragraph; patch by Tshepang Lekhonkhobe 2012-05-13 11:01:20 +02:00
Sandro Tosi 38b86b4cf5 correctly define what 'fill' could be; thanks to Leland Hulbert from docs@ 2012-05-12 23:29:32 +02:00
Antoine Pitrou a9494f6c53 Some nits in the pickle docs. 2012-05-10 15:38:30 +02:00
Ezio Melotti bf3165b971 #14763: document default maxsplit value for str.split. 2012-05-10 15:30:42 +03:00
R David Murray b98b37f101 Improve the grammar of a non-sentence. 2012-05-08 21:28:24 -04:00
Ezio Melotti 6cc7a41c2f #14034: added the argparse tutorial. Patch by Tshepang Lekhonkhobe. 2012-05-06 16:15:35 +03:00
Ned Deily 2e20968feb Issue #10433: Document unique behavior of 'os.getgroups' on Mac OS X. 2012-04-30 11:14:02 -07:00
Ezio Melotti 3d6d7a5e15 #14558: document the module, argv, and testLoader args of unittest.main. 2012-04-30 19:10:28 +03:00
Senthil Kumaran 290416f364 Issue11352 - Update cgi module docs 2012-04-30 22:43:13 +08:00
Ezio Melotti a0b1d1eea2 #14519: fix the regex used in the scanf example. 2012-04-29 11:47:28 +03:00
Ezio Melotti b8e336b974 Fix markup in unittest doc. 2012-04-29 10:52:18 +03:00
Senthil Kumaran db727b4a77 Fix issue6085 - Remove the delay caused by fqdn lookup while logging in BaseHTTPRequestHandler 2012-04-29 13:41:03 +08:00
Ezio Melotti 0a6b5419b0 #14461: fix wording. 2012-04-29 07:34:46 +03:00
Senthil Kumaran 8dc500476a issue14427 - Document Request.get_header and Request.header_items 2012-04-29 11:50:39 +08:00
Ezio Melotti 285e51b7e0 #14155: add a note about \b. 2012-04-29 04:52:30 +03:00
Sandro Tosi 100b889ccd Issue #14448: add reference to IANA timezone database; thanks to Georg/Nick suggestions 2012-04-28 11:19:37 +02:00
Sandro Tosi d11d0d6343 Issue #14448: mention pytz; patch by Andrew Svetlov 2012-04-24 19:46:06 +02:00
Sandro Tosi 3e29d93007 Issue #14554: correct example for captured_stdout(); patch by Tshepang Lekhonkhobe 2012-04-24 18:39:24 +02:00
Sandro Tosi e6c3462607 Issue #13478: document timeit.default_timer() 2012-04-24 18:11:46 +02:00
Senthil Kumaran a42665f4d4 issue2193 - Update 3.2 docs about legal characters allowed in Cookie name 2012-04-22 10:30:17 +08:00
Ned Deily cc19140607 Remove webbrowser doc reference to the previously removed internet-config option. 2012-04-18 12:48:52 -07:00
Sandro Tosi 1ee17198c8 fix typo; thanks to Jérôme Mainka from docs@ 2012-04-14 16:01:17 +02:00
Ezio Melotti 84e59aa989 Fix highlight and spacing in json example. 2012-04-13 21:02:18 -06:00
Ezio Melotti f86b28e3d2 #14535: fix code highlight in multiprocessing examples. Patch by Tshepang Lekhonkhobe. 2012-04-13 20:50:48 -06:00
R David Murray e7bade568e #14553: fix word order.
Patch by Tshepang Lekhonkhobe.
2012-04-11 20:13:25 -04:00
R David Murray 644cabed4b #14552: remove redundant wording in 'test' docs.
Original patch by Tshepang Lekhonkhobe.
2012-04-11 20:11:53 -04:00
Antoine Pitrou f6cd9b2d46 Improve the threading.Condition docs. 2012-04-11 19:37:56 +02:00
Georg Brandl 2c5807572f Closes #14545: make clearer what was added. 2012-04-11 18:33:17 +02:00
Antoine Pitrou b96a354556 Small improvements to the threading docs: better publicize support for the with statement. 2012-04-10 22:47:55 +02:00
Antoine Pitrou 2c9f1042c6 Fix some markup in the threading docs. 2012-04-10 22:35:53 +02:00
Antoine Pitrou 126aef768d Issue #8799: Fix and improve the threading.Condition documentation. 2012-04-10 22:24:05 +02:00
Vinay Sajip 074faff925 Updated logging reference and HOWTO. 2012-04-10 19:59:50 +01:00
Senthil Kumaran cc4979092f minor .rst fix 2012-04-10 19:51:00 +08:00
Sandro Tosi fee3fc748e Issue #14502: release() and unlocked lock generates a ThreadError 2012-04-05 22:51:54 +02:00
R David Murray 28b8b94760 #14481: fix formatting of example in subprocess docs. 2012-04-03 08:46:48 -04:00
Antoine Pitrou 6afd11c762 Issue #14456: improve documentation of the signal module w.r.t. threads. 2012-03-31 20:56:21 +02:00
Sandro Tosi 317075de29 use unittest.skip; thanks to Chang Min Jeon from docs@ 2012-03-31 18:34:59 +02:00
Sandro Tosi 9ee65f1f92 add 'safari' to webbrowser browsers table; thanks to Jonathan Eunice from docs@ 2012-03-31 17:23:10 +02:00
R David Murray 5e0c57142d #10423: clarify options vs args in argparse discussion of optparse
Patch by Sandro Tosi.
2012-03-30 18:07:42 -04:00
R David Murray 07cf1d8085 #14416: add missing LOG_SYSLOG facility to syslog docs. 2012-03-29 06:47:35 -04:00
Sandro Tosi 99e7d0706e Issue #14410: fix typo in argparse doc; patch by Tshepang Lekhonkhobe 2012-03-26 19:36:23 +02:00
Vinay Sajip 8ece80faae Minor documentation tweak. 2012-03-26 17:09:58 +01:00
R David Murray 1623afff67 #14355: remove obsolete doc reference to previously removed init_frozen.
Patch by Eric Snow.
2012-03-18 20:50:03 -04:00
Georg Brandl 3a19e542ff Closes #14250: regex.flags has not only explicit flags but also implicit flags and those from the pattern 2012-03-17 17:29:27 +01:00
Georg Brandl 557a3ec9bb Closes #14343: avoid shadowing builtin input() in example code. 2012-03-17 17:26:27 +01:00
Georg Brandl 5ec6fdb0f6 Closes #14342: remove out-of-date section about avoiding recursion errors. 2012-03-17 17:25:47 +01:00
Senthil Kumaran f2123d2db5 3.2 explain json.dumps for non-string keys in dicts. closes issue6566. Patch contributed Kirubakaran Athmanathan 2012-03-17 00:40:34 -07:00
R David Murray 41914349ad #11780: s/throw/raise/ 2012-03-16 22:10:00 -04:00
R David Murray 69ebfe43b0 #11780: document that email.encoders throw TypeError on multipart messages. 2012-03-16 22:03:17 -04:00
Eli Bendersky 969b8daf5a Issue #14202: some additional doc fixes 2012-03-16 16:49:58 +02:00
Eli Bendersky 3fb05a90ce Issue #14202: Greatly enhance the documentation of xml.dom.pulldom.
Patch by Florian Mladitsch
2012-03-16 14:37:14 +02:00
Eli Bendersky 604c4ff43d Issue #9257: clarify the events iterparse accepts 2012-03-16 08:41:30 +02:00
Senthil Kumaran 6b3434ae04 Explain the use of charset parameter with Content-Type header. Issue11082 2012-03-15 18:11:16 -07:00
R David Murray 38c2754652 #12758: removing confusing mention of UTC from time.time description
Patch by Dylan Sarber.
2012-03-15 03:06:15 -04:00
Senthil Kumaran 87684e6eea Fix the wrong urllib exampls which use str for POST data. Closes Issue11261 2012-03-14 18:08:13 -07:00
Georg Brandl 69c7a69cbe Closes #14283: match() and search() are regex methods, not match methods. 2012-03-14 08:02:43 +01:00
Senthil Kumaran 21c71bac5f closes Issue12365 - Add an example explaining the context manager use case of urllib.urlopen 2012-03-13 19:47:51 -07:00
Mark Dickinson 328dd0d5f3 Closes #9574: Note that complex constructor doesn't allow whitespace around central operator. 2012-03-10 16:09:35 +00:00
Jason R. Coombs 30b8e5461d Use PEP-8 style in logging example 2012-03-07 10:26:08 -05:00
Éric Araujo e5eec7e198 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:01:41 +01:00
Eli Bendersky b2b18632ce merge 3.2 heads 2012-03-02 07:43:08 +02:00
Eli Bendersky 20293441da Issue #11379: add a note in xml.dom.minidom suggesting to use etree in some cases 2012-03-02 07:37:13 +02:00
Petri Lehtinen 4d2bfb5e08 sqlite3: Port documentation changes from the 2.7 branch
Issue #13491.
2012-03-01 21:48:38 +02:00
Ezio Melotti 443f000bdd #14155: remove duplication about search vs match in re doc. 2012-02-29 13:39:05 +02:00
Ezio Melotti 5a045b9f54 #10713: Improve documentation for \b and \B and add a few tests. Initial patch and tests by Martin Pool. 2012-02-29 11:48:44 +02:00
Sandro Tosi 83c48822c5 s/div/truediv/; thanks to Félix-Antoine Fortin from docs@ 2012-02-28 22:28:28 +01:00
Gregory P. Smith 3bbdc8e822 Issue #14123: Explicitly mention that old style % string formatting has caveats
but is not going away any time soon.
2012-02-26 01:54:07 -08:00
Éric Araujo a6091998af Use const markup instead of a misleading string literal 2012-02-26 02:13:30 +01:00
Georg Brandl eb25fb7af7 Fix markup errors. 2012-02-23 21:12:39 +01:00
Georg Brandl 09a7c72cad Merge from 3.1: Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
in order to make algorithmic complexity attacks on (e.g.) web apps much more complicated.

The environment variable PYTHONHASHSEED and the new command line flag -R control this
behavior.
2012-02-20 21:31:46 +01:00
Georg Brandl 2daf6ae249 Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
in order to make algorithmic complexity attacks on (e.g.) web apps much more complicated.

The environment variable PYTHONHASHSEED and the new command line flag -R control this
behavior.
2012-02-20 19:54:16 +01:00
Vinay Sajip fee358b0df logging: clarified documentation for Handler.handleError. 2012-02-20 18:35:26 +00:00
Éric Araujo c3ef037ee1 Add missing “::” markup.
Also wrap two looong lines.
2012-02-20 01:44:55 +01:00
Sandro Tosi 0467686e07 Issue #13605: use print() in argparse nargs example 2012-02-19 19:54:00 +01:00
Sandro Tosi 76dea27421 Indent 'File' in memoryview example, so it is correctly highlighted 2012-02-19 12:28:01 +01:00
Sandro Tosi c33ae06cbf fix error in memoryview example; thanks to kan lianlian from docs@ 2012-02-18 16:05:34 +01:00
Ezio Melotti 4279bc7aef #14020: improve HTMLParser documentation. 2012-02-18 02:01:36 +02:00
Petri Lehtinen b3890226b3 sqlite3: Fix documentation errors concerning Cursor.rowcount
Closes #13995.
2012-02-16 21:39:03 +02:00
Sandro Tosi 5cb522cb32 Issue #11836: document multiprocessing.queues.SimpleQueue 2012-02-15 23:14:21 +01:00
Petri Lehtinen 1ca93954e1 Issue #13491: Fix many errors in sqlite3 documentation
Initial patch by Johannes Vogel.
2012-02-15 22:21:01 +02:00
Éric Araujo ccddc474c3 Improve doc for atexit.register and unregister (#12297) 2012-02-15 17:07:49 +01:00
Senthil Kumaran 7f728c1e1a shutil copy module reference doc fix. 2012-02-13 23:30:47 +08:00
Gregory P. Smith 58f23ffb21 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:50:21 -08:00
Nadeem Vawda 30d94b7aea Issue #13989: Document that GzipFile does not support text mode.
Also, give a more helpful error message when opened with an invalid mode string.
2012-02-11 23:45:10 +02:00
Senthil Kumaran 5b14d732d8 Issue #9021 - Introduce copy module better. Doc changes suggested by Terry
Reedy.
2012-02-09 18:26:59 +08:00
Senthil Kumaran 6e13f130a9 Fix Issue #6005: Examples in the socket library documentation use sendall,
where relevant, instead send method.
2012-02-09 17:54:17 +08:00
Éric Araujo cd2a6033ac Branch merge 2012-02-05 13:41:47 +01:00
Nadeem Vawda bd249c1bae Clarify note in BZ2File docs about lack of multi-stream support (issue #1625). 2012-02-05 14:29:00 +02:00
Georg Brandl 9701eb6e14 Closes #13944: fix capitalization of class name. 2012-02-05 09:25:22 +01:00
Nadeem Vawda 8f50912f87 Issue #1625: Document BZ2File's lack of support for multi-stream inputs. 2012-02-04 23:44:49 +02:00
Benjamin Peterson f51ebf94bb threading primitives now have timeouts 2012-02-04 09:55:52 -05:00
Petri Lehtinen 9713321f46 Document absoluteness of sys.executable
Closes #13402.
2012-02-02 20:59:50 +02:00
Brian Curtin 090ec3c7fc merge. again. 2012-02-01 15:24:10 -06:00
Brian Curtin 10dda6e029 Add a hint that CSD == Service Pack.
People searcing for the way to get a "service pack" will never find that we
provide it here, and people that find this function won't know what CSD is
until they run the function. On top of this, they won't know what the value
means unless they really have a service pack installed.

CSD, or Customer Service Diagnostics, is apparently no longer used, and was
rarely used term at that. Most references to it online are from
universities making Windows 2000 and XP service packs available to students.
2012-02-01 15:14:00 -06:00
Raymond Hettinger fc3ba6b8fc Add usage note 2012-02-01 09:07:40 -08:00
Georg Brandl c875d2032b Fix #13900: resolve self-referential description of a parameter. 2012-01-29 15:38:47 +01:00
Benjamin Peterson 871b9d169d note that get() is not affected by default_factory (closes #13887) 2012-01-27 09:14:01 -05:00
Antoine Pitrou 9f6b02ecde Clarify that ssl.OP_ALL can be different from OpenSSL's SSL_OP_ALL. 2012-01-27 10:02:55 +01:00
Meador Inge 65992c1c01 - Issue #13840: Fix ctypes.create_string_buffer exception message and docs. 2012-01-26 08:44:00 -06:00
Georg Brandl 6c89a79d55 #13852: some small doc fixes. 2012-01-25 22:36:25 +01:00
Benjamin Peterson b4b0b354dd kill extra word 2012-01-25 16:30:18 -05:00
Benjamin Peterson e9fca253d0 say bitwise (because I have no idea what a bit-string is) 2012-01-25 16:29:03 -05:00
Antoine Pitrou 5311c1d7ab Issue #13772: In os.symlink() under Windows, do not try to guess the link
target's type (file or directory).  The detection was buggy and made the
call non-atomic (therefore prone to race conditions).
2012-01-24 08:59:28 +01:00
Georg Brandl 3b65fd7e97 #13816: fix two minor style issues. Thanks to Justin Wehnes for the patch. 2012-01-23 20:19:33 +01:00
Antoine Pitrou f49d152ab2 Issue #12922: fix the TextIOBase documentation to include a description of seek() and tell() methods. 2012-01-21 20:20:49 +01:00
Sandro Tosi 41b2404dab fix typo; thanks to Justin Watt from docs@ 2012-01-21 10:59:37 +01:00
Sandro Tosi da8e11ac71 Issue #13605: more meaningful example + fixes 2012-01-19 22:23:00 +01:00
Sandro Tosi 16bd0b4463 Issue #13605: add documentation for nargs=argparse.REMAINDER 2012-01-19 21:59:55 +01:00
Meador Inge 972cfb9169 Issue #2134: Clarify token.OP handling rationale in tokenize documentation. 2012-01-19 00:22:22 -06:00
Éric Araujo f2fbb9cf42 Improve interlinking of archiving/compression modules docs.
- Remove duplicated list of links to the other modules from each
  module’s doc (people can already go up to library/archiving and
  there they can see the list).

- Link to shutil high-level operations.

Reviewed by Nadeem Vawda in #6715.
2012-01-16 16:55:55 +01:00
Éric Araujo 6f7aa00c1e Document json.dump ensure_ascii parameter (#13770) 2012-01-16 10:09:20 +01:00
Ezio Melotti 01b34afb3a #13715: fix typo in unicodedata doc. Patch by Eli Collins. 2012-01-16 08:42:32 +02:00
Ezio Melotti 9ecb6beb8c #13695: fix a couple of typos in the doc. 2012-01-16 08:28:54 +02:00
Gregory P. Smith c1f079f317 Mention the additional way to use the lvl parameter and when it changed. 2012-01-14 12:46:17 -08:00
Terry Jan Reedy a931463fea #13730 grammar fix 2012-01-13 23:43:13 -05:00
Terry Jan Reedy a3d1e2e342 #11633 At least 2 people prefer earlier revision. 2012-01-12 14:49:02 -05:00
Antoine Pitrou 889a5101c2 Issue #13724: improve documentation for socket.create_connection. 2012-01-12 08:06:19 +01:00
Terry Jan Reedy e247928fed Closes #11633 Clarify print buffering. 2012-01-11 14:09:49 -05:00
Terry Jan Reedy f4ec3c5a92 #13754 String returned if less than *or equal to* x 3
Close *13753 'seq' now 'iterable'
2012-01-11 03:29:42 -05:00
Senthil Kumaran 19d85c2762 Issue9637 - Explain in getproxies_environment that <scheme>_proxy environ variable case does not matter. 2012-01-11 01:29:08 +08:00
Antoine Pitrou ac8bfcacfc Issue #13747: fix SSL compatibility table. 2012-01-09 21:43:18 +01:00
Antoine Pitrou 84a2edcdf7 Issue #13747: fix documentation error about the default SSL version. 2012-01-09 21:35:11 +01:00
Charles-François Natali ded0348c08 Issue #13502: threading: Fix a race condition in Event.wait() that made it
return False when the event was set and cleared right after.
2012-01-07 18:24:56 +01:00
Sandro Tosi b52e7a9a36 clarify recv* are blocking operations; thanks to Chris Kogelnik from docs@ 2012-01-07 17:56:58 +01:00
Antoine Pitrou 441ae043df Update printout of SSL certificate examples for 3.2+. 2012-01-06 20:06:15 +01:00
Sandro Tosi ba232dfc83 Issue #11984: remove reference to parser, it's not showing symbol usage anymore 2012-01-05 19:06:25 +01:00
Sandro Tosi 98492a50ea Issue #10772: add count and help argparse action; patch by Marc Sibson 2012-01-04 23:25:04 +01:00
Antoine Pitrou b7ffed8a50 Add a subsection explaning cipher selection. 2012-01-04 02:53:44 +01:00
Sandro Tosi 753b79c073 Issue #6031: improve serve_forever() description 2012-01-03 22:35:54 +01:00
Sandro Tosi ea320abcae Issue #9349: add argparse.SUPPRESS to help doc 2012-01-03 18:37:03 +01:00
Sandro Tosi da785fd527 Issue #13690: add re.DEBUG; patch by Filip Gruszczyński 2012-01-01 12:55:20 +01:00
Sandro Tosi 1abde3628b fix some broken URLs 2011-12-31 18:46:50 +01:00
Eli Bendersky d08effe287 Some formatting & grammar fixes for the multiprocessing doc 2011-12-31 07:20:26 +02:00
Benjamin Peterson a6c4a10d4e indicate msg is an argument 2011-12-30 23:08:09 -06:00
Benjamin Peterson 79ed84c7f2 use booleans 2011-12-30 13:47:25 -06:00
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