Commit Graph

4135 Commits

Author SHA1 Message Date
Antoine Pitrou 15251a99bb Add glossary references 2012-08-24 19:49:08 +02:00
Antoine Pitrou cbf9d5f6cd Issue #14674: Add a discussion of the json module's standard compliance.
Patch by Chris Rebert.
2012-08-24 19:39:47 +02:00
Antoine Pitrou 331624b67d Issue #14674: Add a discussion of the json module's standard compliance.
Patch by Chris Rebert.
2012-08-24 19:37:23 +02:00
Nick Coghlan 83c0ae5de6 Address most of Ezio's comments. str/bytes/bytearray docs still need consolidation 2012-08-21 17:42:52 +10:00
Antoine Pitrou 609939e22f Issue #14954: Clarify the interaction of weak references and garbage collection.
Patch by Ethan Furman.
2012-08-21 00:07:35 +02:00
Antoine Pitrou 9439f04b9a Issue #14954: Clarify the interaction of weak references and garbage collection.
Patch by Ethan Furman.
2012-08-21 00:07:07 +02:00
R David Murray 1ea50f5608 Merge #15742: clarify sqlite parameter substitution example.
Suggestion and patch by Mike Hoy.
2012-08-20 14:14:46 -04:00
R David Murray f6bd1b0e0d #15742: clarify sqlite parameter substitution example.
Suggestion and patch by Mike Hoy.
2012-08-20 14:14:18 -04:00
Nick Coghlan bac9a53d00 Break up the 'someos' docs classification based on a more user-focused scheme, including creation of a separate 'Concurrent Execution' section 2012-08-20 18:05:46 +10:00
Nick Coghlan 273069cf7d Close #4966: revamp the sequence docs in order to better explain the state of modern Python 2012-08-20 17:14:07 +10:00
Nick Coghlan a8517ad3d9 Issue #14814: document the Interface APIs and fix various problems with the string representations (initial patch by Eli Bendersky). 2012-08-20 10:04:26 +10:00
R David Murray 749bd42072 Merge #13579: teach string.Formatter about 'a'.
Patch by Francisco Martín Brugué.
2012-08-19 17:45:40 -04:00
R David Murray e56bf97ef4 #13579: teach string.Formatter about 'a'.
Patch by Francisco Martín Brugué.
2012-08-19 17:26:34 -04:00
Eli Bendersky a1b0f6d9be Issue #15586: fix prompts in some documentation examples 2012-08-18 05:42:22 +03:00
R David Murray cd7128a549 Merge #15636: add versionadded for decodebytes 2012-08-17 20:55:54 -04:00
R David Murray 75fd22519f #15636: add versionadded for decodebytes 2012-08-17 20:55:21 -04:00
R David Murray ed7fb9c74d Merge #15694: reflow paragraph. 2012-08-17 20:40:03 -04:00
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