Commit Graph

4393 Commits

Author SHA1 Message Date
Andrew Svetlov ec42255039 Issue #16371: fix typo in ctypes documentation.
Thanks to George Yoshida.
2012-10-31 16:20:54 +02:00
Andrew Svetlov 7ea6f706ac Fix typo in mock docs. 2012-10-31 11:29:52 +02:00
Brian Curtin 6b879fa402 Merge 3.2 2012-10-29 18:18:43 -05:00
Brian Curtin e9aeca7c24 Fix #16197. Update docstrings and documentation to match winreg code.
Patch by Zachary Ware.
2012-10-29 18:16:39 -05:00
Chris Jerdonek d285029ee8 Merge from 3.2: remove unneeded "Release" and "Date" markers from index pages. 2012-10-28 11:10:24 -07:00
Chris Jerdonek 8b7f9f581d Remove unneeded "Release" and "Date" markers from doc index pages. 2012-10-28 11:08:26 -07:00
Andrew Svetlov 21b102481b merge heads 2012-10-28 14:12:50 +02:00
Andrew Svetlov 6d50a5447a Merge issue #14570: Document json sort_keys parameter properly.
Patch by Chris Rebert.
2012-10-28 14:11:00 +02:00
Andrew Svetlov 2ec53be2e2 Issue #14570: Document json sort_keys parameter properly.
Patch by Chris Rebert.
2012-10-28 14:10:30 +02:00
Andrew Svetlov c2415eb7e6 Issue #14616: Mention shlex.quote in subprocess docs.
Patch by Chris Rebert.
2012-10-28 11:42:26 +02:00
Ezio Melotti 971ba4c817 #16337: fix typo. 2012-10-27 23:25:18 +03:00
Senthil Kumaran 0b3014dda0 merge from 3.2 2012-10-27 11:05:32 -07:00
Senthil Kumaran 847c33cc3b Include mention of jenkins as an example framework for doing CI 2012-10-27 11:04:55 -07:00
Andrew Svetlov 735d31723f Issue #16243: add example for inspect.formatargspec
Patch by Berker Peksag.
2012-10-27 00:28:20 +03:00
Ezio Melotti a5941f8643 #16206: merge with 3.2. 2012-10-26 19:15:26 +03:00
Ezio Melotti a20879ffc8 #16206: Improve examples about dict construction. 2012-10-26 19:14:16 +03:00
Ezio Melotti e6c0f0d94a #16210: merge with 3.2. 2012-10-24 23:06:56 +03:00
Ezio Melotti 837cd06d36 #16210: combine the two type() docs. Patch by Pete Sevander. 2012-10-24 23:06:25 +03:00
Ezio Melotti 1f67e80564 Fix typo. 2012-10-21 07:24:13 +03:00
Ezio Melotti b24d3cf769 Fix indentation (or Sphinx will think these are attributes of ConnectionError). 2012-10-21 03:22:05 +03:00
Ned Deily d2cc1bb057 Issue #10405: merge from 3.2 2012-10-20 13:27:32 -07:00
Ned Deily 2778d0d147 Issue #10405: Document IDLE context menus in Standard Library document
and IDLE Help file.  (Thanks to Nick ODell and Todd Rovito for suggestions.)
Update Debug menu options in docs to match current code plus various other
minor IDLE doc and help edits.
2012-10-20 13:25:34 -07:00
Nick Coghlan 40c67739ba Fix typo in example (pointed out by a couple of people, most recently Ken Rimey) 2012-10-20 20:13:21 +10:00
Nick Coghlan d6d5cf33ef A dict comprehension is much prettier (thanks Antoine) 2012-10-16 23:14:03 +10:00
Nick Coghlan f06ea25df2 Tweak the threaded example in concurrent.futures 2012-10-16 22:50:04 +10:00
Andrew Svetlov 2bfe386091 Issue #15936: Reformat text for os.random to follow Larry Hastings suggestion 2012-10-16 13:52:25 +03:00
Andrew Svetlov 03cb99c2d1 Issue #15936: Add link from os.urandom to random.SystemRandom 2012-10-16 13:15:06 +03:00
Chris Jerdonek 39b867000b Issue #16206: Merge dict documentation improvements from 3.2.
Improve the documentation of the dict constructor.  This change includes
replacing the single-line signature documentation with a more complete
multiple-line signature.
2012-10-13 03:25:18 -07:00
Chris Jerdonek f341317185 Issue #16206: Improve the documentation of the dict constructor.
This change includes replacing the single-line signature documentation
with a more complete multiple-line signature.
2012-10-13 03:22:33 -07:00
Chris Jerdonek 006d907afc Undo changes accidentally reverted in de8787029fe4. 2012-10-12 20:28:26 -07:00
Benjamin Peterson b548d49f65 merge heads 2012-10-12 12:05:01 -04:00
Benjamin Peterson 143d034ecd merge 3.2 2012-10-12 12:04:32 -04:00
Ezio Melotti 1dd7c30419 Merge __next__ method link fixes with 3.2. 2012-10-12 13:45:38 +03:00
Ezio Melotti 7fa822275b Fix links to the __next__ method. 2012-10-12 13:42:08 +03:00
Ezio Melotti a6229e6ebd Fix and add more links. 2012-10-12 10:59:14 +03:00
Chris Jerdonek c33899bd71 Add and adjust some string-related links in the docs. 2012-10-11 18:57:48 -07:00
Chris Jerdonek caf380ac2a Issue #16199: Merge 2to3 typo fix from 3.2. 2012-10-11 16:01:00 -07:00
Chris Jerdonek 463974916d Issue #16199: Fix typo in 2to3 docs. Thanks to Mark Lawrence for the report. 2012-10-11 15:59:32 -07:00
Chris Jerdonek c3de6d63cd Merge from 3.2: Fix placement of shell=True warning in subprocess.Popen() docs. 2012-10-10 22:53:35 -07:00
Chris Jerdonek cc32a68216 Fix placement of shell=True warning in subprocess.Popen() docs. 2012-10-10 22:52:22 -07:00
Chris Jerdonek 02860526eb Issue #16115: Merge subprocess.Popen() documentation improvements from 3.2. 2012-10-10 17:47:55 -07:00
Chris Jerdonek 4a4a02bbc8 Issue #16115: Make further improvements to subprocess.Popen() documentation. 2012-10-10 17:46:18 -07:00
Chris Jerdonek 3fa8c59024 Issue #12947: Remove doctest directives from the doctest examples in the "Option Flag" section.
The doctest examples that illustrate the use of doctest option flags
independent of doctest directives should not display doctest directives.
2012-10-10 08:34:38 -07:00
Georg Brandl 23a87de96f Missed one instance of code-block:: text highlighting to revert. 2012-10-10 16:56:15 +02:00
Georg Brandl a1ff83e556 merge 3.2 heads 2012-10-10 16:49:02 +02:00
Georg Brandl 83e51f48a8 Issue #12947: revert earlier workaround and use a monkey-patch to enable showing doctest directives only in the doctest docs. 2012-10-10 16:45:11 +02:00
Georg Brandl 3a2e101be5 Issue #12947: revert earlier workaround and use a monkey-patch to enable showing doctest directives only in the doctest docs. 2012-10-10 16:45:11 +02:00
Chris Jerdonek 3650ea2a9f Issue #12947: Divide doctest "Option Flags and Directives" section into two.
This changeset also applies the rendering workaround to the last remaining
example in the file that has a doctest directive that should be displayed.
2012-10-10 06:52:08 -07:00
Eli Bendersky 831893a68e Issue #16082: clarify the documentation of tostring[list] saying that it may generate a bytestring, depending on the given encoding. 2012-10-09 07:18:16 -07:00
Eli Bendersky 323a43af06 Issue #12322: clarify xpath reference for cases where the path reaches ancestors of the start element. Also add missing markup for a None. Thanks to patrick vrijlandt and Mike Hoy for the report and initial patches. 2012-10-09 06:46:33 -07:00
Andrew Svetlov 38714d64d0 Merge issue #16174: Fix suggested usage of dummy_threading module.
Patch by Berker Peksag.
2012-10-09 13:44:48 +03:00
Andrew Svetlov a256841b4b Issue #16174: Fix suggested usage of dummy_threading module.
Patch by Berker Peksag.
2012-10-09 13:44:16 +03:00
Chris Jerdonek ad01498fa9 Issue #16115: Merge subprocess.Popen() documentation improvements from 3.2. 2012-10-08 23:12:21 -07:00
Chris Jerdonek 470ee39883 Issue #16115: Improve subprocess.Popen() documentation around args, shell, and executable arguments. 2012-10-08 23:06:57 -07:00
Hynek Schlawack 101591e9d5 Merge 3.2 2012-10-08 07:44:54 +02:00
Chris Jerdonek 042fa653ab Issue #14783: Merge changes from 3.2. 2012-10-07 14:56:27 -07:00
Chris Jerdonek 83fe2e1c22 Issue #14783: Improve int() docstring and also str(), range(), and slice().
This commit rewrites the docstring for int() to incorporate the documentation
changes made in issue #16036.  It also switches the docstrings for int(),
str(), range(), and slice() to use multi-line signatures.
2012-10-07 14:48:36 -07:00
Hynek Schlawack 0230b6af78 #13498: Clarify docs of os.makedirs()'s exist_ok argument.
Done with great native-speaker help from R. David Murray.
2012-10-07 18:04:38 +02:00
Eli Bendersky 948af23a77 Issue #15888: fixing problems in ipaddress doctests. Patch by Chris Jerdonek 2012-10-07 07:23:50 -07:00
R David Murray ace5162294 starmap/starmap_async for whatsnew, and fix multiprocessing Pool markup. 2012-10-06 22:26:52 -04:00
R David Murray ca76ea16ad #9957: document that SpooledTemporaryFile.truncate now accepts a size arg 2012-10-06 18:32:39 -04:00
R David Murray 138a314d1a #9957: document that SpooledTemporaryFile.truncate does not take size arg 2012-10-06 18:26:56 -04:00
Georg Brandl 2fdc0f8a86 Fix markup in Counter note. 2012-10-06 22:38:20 +02:00
R David Murray ef4d286770 #10968: commit threading doc changes and corresponding whatsnew entry.
It is unfortunate that the '_' names were not kept as aliases, and that RLock
was not also converted to a class, but it is now too late to change either of
those things for 3.3.
2012-10-06 14:35:35 -04:00
Andrew Svetlov 5061a34283 Issue #16025: Minor corrections to the zipfile documentation.
Patch by Serhiy Storchaka.
2012-10-06 18:10:01 +03:00
Andrew Svetlov afbf90c993 Issue #16025: Minor corrections to the zipfile documentation.
Patch by Serhiy Storchaka.
2012-10-06 18:02:05 +03:00
Georg Brandl fe7b00fb0a Closes #11710: create "landing pages" (/library/package.html) for those packages that have no documented content themselves, e.g. "urllib" or "http". 2012-10-06 13:49:34 +02:00
Ezio Melotti b28e75d9d6 Merge ftplib doc fix with 3.2. 2012-10-05 14:10:39 +03:00
Ezio Melotti cbd449b416 The file obj passed to ftp.storbinary/storlines must be opened in binary mode. 2012-10-05 14:09:59 +03:00
Andrew Svetlov 3934b61a16 Fix typo in documentation for time module, thanks to docs@ 2012-10-04 19:52:32 +03:00
Andrew Svetlov 1a8db9cd1d Fix typo in documentation for collections.ChainMap, thanks to Olivier Bernard from docs@ 2012-10-04 19:29:25 +03:00
Nick Coghlan 0b26ccfaa6 Issue #12947: Better workaround for the problem with doctest directives being stripped from code examples that are intended to illustrate those directives 2012-10-03 13:52:48 +05:30
Nick Coghlan 8f80e0a651 Issue #12947: Add a note to doctest until the example rendering is fixed 2012-10-03 12:21:44 +05:30
Ezio Melotti 4443762bf5 #15979: merge with 3.2. 2012-10-02 06:01:16 +03:00
Ezio Melotti d0fe3e5abb #15979: improve timeit documentation. 2012-10-02 05:35:39 +03:00
R David Murray 258fabefde #11109: clean up docs, add whatsnew entry, and fix Justin's last name. 2012-10-01 21:43:46 -04:00
R David Murray 842ca5f15d Merge: Fix sqlite3 class markup. 2012-09-30 20:49:19 -04:00
R David Murray 6db2335f77 Fix sqlite3 class markup. 2012-09-30 20:44:43 -04:00
Gregory P. Smith 89bbe68195 doc typo fixes 2012-09-30 10:36:07 -07:00
Chris Jerdonek 28714c8c26 Issue #15533: Merge fix from 3.2. 2012-09-30 02:15:37 -07:00
Chris Jerdonek ec3ea94251 Issue #15533: Clarify docs and add tests for subprocess.Popen()'s cwd argument. 2012-09-30 00:10:28 -07:00
R David Murray ad4d9c9bf0 Merge #16085: Don't promote shadowing builtins in the configparser example. 2012-09-29 14:40:56 -04:00
R David Murray 1a1883d566 #16085: Don't promote shadowing builtins in the configparser example. 2012-09-29 14:40:23 -04:00
Georg Brandl 99a247fd01 Merge with main repo default branch. 2012-09-29 09:27:15 +02:00
Georg Brandl a79b8dc917 Add a versionchanged note for #9374 changes. 2012-09-29 08:59:23 +02:00
R David Murray 7dcbd2c873 Merge #16071: fix more email.message links in mailbox docs. 2012-09-28 15:19:42 -04:00
R David Murray 5320250485 #16071: fix more email.message links in mailbox docs. 2012-09-28 15:19:16 -04:00
R David Murray fb8a49e080 Merge #16071: fix links to email.message.Message in mailbox docs. 2012-09-28 15:10:12 -04:00
R David Murray c5fe4073af #16071: fix links to email.message.Message in mailbox docs. 2012-09-28 15:09:31 -04:00
Michael Foord 28d591ceef Closes issue 15323. Improve failure message of Mock.assert_called_once_with 2012-09-28 16:15:22 +01:00
Michael Foord 207d229933 urllib.parse.urlencode doc updarte.
Closes issue 15593
2012-09-28 14:40:44 +01:00
Nick Coghlan 74cca70ce2 Now that it's possible, avoid timing attacks in the crypt module examples) 2012-09-28 18:50:38 +05:30
Chris Jerdonek 2246aa8ac8 Issue #16036: Merge update from 3.2. 2012-09-28 01:15:39 -07:00
Chris Jerdonek 57491e0703 Issue #16036: Improve documentation of built-in int()'s signature and arguments. 2012-09-28 00:10:44 -07:00
Barry Warsaw d09a05ebc5 Merge 3.2 except the massive Misc/NEWS conflict, so hand apply the NEWS entry. 2012-09-25 10:47:55 -04:00
Barry Warsaw 1dedd0a4a4 - Issue #15935: Clarification of argparse docs, re: add_argument() type and
default arguments.  Patch contributed by Chris Jerdonek.
2012-09-25 10:37:58 -04:00
Nadeem Vawda 5011244be0 Prefer lzma.open() over lzma.LZMAFile() in lzma module documentation. 2012-09-23 18:20:23 +02:00
Nadeem Vawda 667a13bf2a Fix indentation of examples in lzma module documentation. 2012-09-23 18:08:57 +02:00
Victor Stinner a3ff101e6a Issue #5969: faulthandler module: rename dump_tracebacks_later() to
dump_traceback_later() and cancel_dump_tracebacks_later() to
cancel_dump_traceback_later().
2012-09-23 11:06:21 +02:00
Larry Hastings a867ed553e Cleanup/rewrite shutil docs regarding follow_symlinks and copying attributes. 2012-09-21 10:12:14 -07:00
Larry Hastings bf84bbabbb Mention that "defaults" can be None for inspect.getfullargspec.
Also minor formatting cleanups.
2012-09-21 09:40:41 -07:00
Mark Dickinson 7c6c80d89f Issue 15985: merge from 3.2. 2012-09-20 20:51:53 +01:00
Mark Dickinson 4e12ad19c9 Issue 15985: fix round argument names in documentation. Thanks Chris Jerdonek. 2012-09-20 20:51:14 +01:00
Ezio Melotti fe6e7e6b30 Merge the quotes/backslashes fixes with 3.2. 2012-09-20 09:47:41 +03:00
Ezio Melotti 694f2331c6 Fix a few quotes/backslashes. 2012-09-20 09:47:03 +03:00
Ezio Melotti a58d8b05df Merge markup fixes in smtpd.rst with 3.2. 2012-09-20 09:09:24 +03:00
Ezio Melotti 8bbcb584dd Fix markup in smtpd.rst. 2012-09-20 09:06:51 +03:00
Ezio Melotti f6813f6071 Merge rst markup fixes in timeit docs with 3.2. 2012-09-20 06:14:54 +03:00
Ezio Melotti a3ccb237c7 Fix rst markup in timeit docs. 2012-09-20 06:13:38 +03:00
Ezio Melotti 4a5fae1b79 #11643: merge with 3.2. 2012-09-17 09:01:03 +02:00
Ezio Melotti 26e5878d6f #11643: fix rst markup error in site.rst. 2012-09-17 08:59:36 +02:00
Ezio Melotti a5377cafea #15789: merge with 3.2. 2012-09-15 08:34:47 +03:00
Ezio Melotti 186d5238ea #15789: mention shell-like parts of the stdlib in the subprocess docs. Patch by Chris Rebert. 2012-09-15 08:34:08 +03:00
Ezio Melotti 711f093030 #15932: merge with 3.2. 2012-09-15 05:52:36 +03:00
Ezio Melotti e34f8a943b #15932: use with statement in csv doc examples. Patch by Dario Bertini. 2012-09-15 05:51:45 +03:00
Ezio Melotti 8429b6784b #15831: merge with 3.2 2012-09-14 06:35:09 +03:00
Ezio Melotti e0add76468 #15831: document multiple signatures on different lines. Patch by Chris Jerdonek. 2012-09-14 06:32:35 +03:00
R David Murray ce478b9891 #15886: remove redundant phrase 2012-09-10 21:08:50 -04:00
R David Murray c3bfb01a95 Merge #14649: clarify DocTestSuite error when there are no docstrings.
Also adds tests to verify the documented behavior (which is probably a bug, as
indicated in the added comments).

Patch by Chris Jerdonek.
2012-09-10 10:16:46 -04:00
R David Murray 5abd76a75d #14649: clarify DocTestSuite error when there are no docstrings.
Also adds tests to verify the documented behavior (which is probably a bug, as
indicated in the added comments).

Patch by Chris Jerdonek.
2012-09-10 10:15:58 -04:00
Richard Oudkerk c3a2c59806 Merge 2012-09-10 13:06:02 +01:00
Richard Oudkerk b517596721 Issue #15901: Change example to use byte string instead of string 2012-09-10 13:00:33 +01:00
Larry Hastings 60eba57f3e Cleanup/rewrite shutil docs regarding follow_symlinks and copying attributes. 2012-09-21 10:12:14 -07:00
Larry Hastings dc07bac29e Mention that "defaults" can be None for inspect.getfullargspec.
Also minor formatting cleanups.
2012-09-21 09:40:41 -07:00
Georg Brandl deb92b5b1b Closes #15969: rename new API to have consistent names in the faulthandler module. 2012-09-22 08:58:55 +02:00
R David Murray 6f5578bab8 Merge #5088: document behavior of optparse defaults with 'append' action. 2012-09-08 16:46:10 -04:00
R David Murray 14d66a98ed #5088: document behavior of optparse defaults with 'append' action. 2012-09-08 16:45:35 -04:00
Ezio Melotti 8bdcdc235e Merge heads. 2012-09-08 20:52:19 +03:00
Ezio Melotti 8b61611309 #15865: merge with 3.2. 2012-09-08 20:49:18 +03:00
Ezio Melotti e927e25637 #15865: add "*" in the signature to document keyword-only args in the docs. Patch by Chris Jerdonek. 2012-09-08 20:46:01 +03:00
R David Murray 0fbbce99c3 Merge #15510: clarify textwrap's handling of whitespace, and add confirming tests.
Patch by Chris Jerdonek.
2012-09-08 13:14:58 -04:00
R David Murray 1585b70813 #15510: clarify textwrap's handling of whitespace, and add confirming tests.
Patch by Chris Jerdonek.
2012-09-08 13:13:25 -04:00
Ross Lagerwall ce66a3e36f Fix a typo in the curses docs 2012-09-06 18:58:43 +02:00
Alexander Belopolsky e8677c038f Issue #15855: updated related manual entries. 2012-09-03 17:29:22 -04:00
Stefan Krah 9c8ad0737a Issue #15814: Documentation: disallow hashing of multi-dimensional memoryviews. 2012-09-02 14:50:56 +02:00
Stefan Krah a3b84fb2f9 Issue #15814: Documentation: disallow hashing of multi-dimensional memoryviews. 2012-09-02 14:50:56 +02:00
Stefan Krah dbf56c2ef3 Issue #15814: Document planned restrictions for memoryview hashes in 3.3.1. 2012-09-01 14:34:45 +02:00
Andrew Svetlov 2d337c7061 Issue #15825: fix typo in OrderedDict docs.
Patch by Mike Hoy.
2012-08-31 13:55:11 +03:00
Andrew Svetlov ff63e7afcf Issue #15825: fix typo in OrderedDict docs.
Patch by Mike Hoy.
2012-08-31 13:54:54 +03:00
Stefan Krah af3f3a7f00 Closes #10650: Deprecate the watchexp parameter of Decimal.quantize(). 2012-08-30 12:33:55 +02:00
Stefan Krah 9ecae7a437 Issue #15814: Document planned restrictions for memoryview hashes in 3.3.1. 2012-09-01 14:34:45 +02:00
Stefan Krah 0f8cab20d9 Closes #10650: Deprecate the watchexp parameter of Decimal.quantize(). 2012-08-30 12:33:55 +02:00
Stefan Krah 2a70535afd Issue #15724: Add versionchanged tags to the memoryview documentation. 2012-08-30 12:09:09 +02:00
Stefan Krah ab0c3c7183 Issue #15724: Add versionchanged tags to the memoryview documentation. 2012-08-30 12:09:09 +02:00
Ezio Melotti 75883ad45a Add missing comma. 2012-08-29 17:52:06 +03:00
Ezio Melotti 49ccd514d2 Add missing comma. 2012-08-29 17:50:42 +03:00
Victor Stinner 1d39cde50c Issue #15785: Modify window.get_wch() API of the curses module: return a
character for most keys, and an integer for special keys, instead of always
returning an integer. So it is now possible to distinguish special keys like
keypad keys.
2012-08-29 01:40:57 +02:00
Petri Lehtinen a0578e94a4 #11964: Document a change in v3.2 to the json indent parameter 2012-08-28 12:34:09 +03:00
Petri Lehtinen 72b1426cfb #11964: Document a change in v3.2 to the json indent parameter 2012-08-28 07:08:44 +03:00
Victor Stinner ca2b64682e Issue #15785: Modify window.get_wch() API of the curses module: return a
character for most keys, and an integer for special keys, instead of always
returning an integer. So it is now possible to distinguish special keys like
keypad keys.
2012-08-29 01:40:57 +02:00
Petri Lehtinen 79dbded0fa Merge: Fix a JSON doc typo 2012-08-27 20:28:08 +03:00
Petri Lehtinen 72c6eefcc6 Fix a JSON doc typo 2012-08-27 20:27:30 +03:00
Ezio Melotti 7f79f7cf23 #15788: merge with 3.2. 2012-08-27 10:03:23 +03:00
Ezio Melotti aa935dfe9c #15788: fix broken links in subprocess doc. Patch by Chris Rebert. 2012-08-27 10:00:05 +03:00
Ezio Melotti d26c306bf1 Fix typo. 2012-08-26 07:33:10 +03:00
Nick Coghlan 06e1ab0a6b Close #15573: use value-based memoryview comparisons (patch by Stefan Krah) 2012-08-25 17:59:50 +10:00
Stefan Krah 029780be09 Issue #13072: The array module's 'u' format code is now deprecated and
will be removed in Python 4.0.
2012-08-24 20:14:12 +02:00
Antoine Pitrou 0ac0b11ec1 Add glossary references 2012-08-24 19:50:43 +02:00
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