Commit Graph

1962 Commits

Author SHA1 Message Date
Ezio Melotti d113512ed5 #10617: add class directives to collections ABCs. 2011-03-28 13:46:28 +03:00
Steven Bethard 5e0062d25a Issue #9343: Document that argparse parent parsers must be configured before their children. (Merge from 3.2.) 2011-03-26 21:50:38 +01:00
Steven Bethard 3f69a059b9 Issue #8982: Improve the documentation for the argparse Namespace object. (Merge from 3.2.) 2011-03-26 19:59:02 +01:00
Éric Araujo 254d4b851d Tweaks to sys.flags description table.
The options listed in the table are now links to their documentation,
and the table uses compact markup to make it easier to read and edit.
First proposed in #10998.
2011-03-26 02:09:14 +01:00
Éric Araujo 8bea9a5b13 Use universal construct os.path.expanduser('~') instead of os.environ['HOME'] 2011-03-26 01:24:47 +01:00
Raymond Hettinger 7250730afc Issue #11625: Fix Typo 2011-03-22 09:06:38 -07:00
Georg Brandl b6dc81df2b Fix duplicate word. 2011-03-21 08:55:16 +01:00
Éric Araujo c75f26511b Fix typo in class name 2011-03-20 18:34:24 +01:00
Benjamin Peterson ec5b5cb489 the name of the option is a bit too low-level 2011-03-20 12:24:20 -05:00
Raymond Hettinger dbc5e1280f Minor doc clean-up.
* Show list of fields option before showing the single string alternative.
* Remove the PS2 prompts so that the examples become cut-and-pastable.
2011-03-19 15:09:00 -07:00
Ezio Melotti c2077b0d9b #11565: Fix several typos. Patch by Piotr Kasprzyk. 2011-03-16 12:34:31 +02:00
R David Murray ab40e4cb95 Merge #11216: document all possible set_charset execution paths. 2011-03-15 18:01:04 -04:00
Ross Lagerwall a3ed3f03d7 Issue #10885: Fix multiprocessing docs typo 2011-03-14 10:43:36 +02:00
Ezio Melotti ad797b699d #11484: remove paragraph about with_traceback from 2.7 doc. 2011-03-13 22:55:41 +02:00
Eli Bendersky ec40bab21e Issue #11426: use 'with' statements on open files in CSV examples 2011-03-13 08:45:19 +02:00
Benjamin Peterson 4f1a665fae clarify condition for readline to return EOF (closes #11312) 2011-03-12 17:12:54 -06:00
Vinay Sajip 5ddf51f735 Fixes issue #11476: StreamHandler parameter name change documented. 2011-03-12 22:43:23 +00:00
Ezio Melotti c3ab30b363 Fix typo. 2011-03-12 22:21:37 +02:00
Benjamin Peterson 3c5edd00a7 trunc -> math.trunc (closes #11475) 2011-03-12 11:58:15 -06:00
R David Murray efd8bab403 #10999: Add missing documentation for chflags constants to stat module docs
Patch by Michal Nowikowski.
2011-03-10 17:57:35 -05:00
Ezio Melotti 3cbb66b0d9 Use simpler assert in basic example. 2011-03-10 23:35:39 +02:00
Ezio Melotti dd7c593c1f Backport from 3.x several improvements and fixes for unittest.rst. 2011-03-10 23:00:48 +02:00
Ezio Melotti 9e1ed47e91 #11298: Improve the unittest discovery explanation. 2011-03-08 17:08:25 +02:00
Georg Brandl 6076c1b40a #11292: add missing A_REVERSE to curses attribute table. 2011-03-06 11:08:35 +01:00
Georg Brandl 6dea5f5702 #11294: add missing ERA_T_FMT to locale docs. 2011-03-06 11:09:51 +01:00
Georg Brandl 3a610a561a #11373: fix spelling. 2011-03-06 10:57:52 +01:00
Georg Brandl 21b832e8c1 #11392: you can trust the computer, but you have to know what it does. 2011-03-06 10:53:55 +01:00
Benjamin Peterson 17e25d8c65 Merged revisions 88668 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r88668 | benjamin.peterson | 2011-02-27 09:06:44 -0600 (Sun, 27 Feb 2011) | 1 line

  make this a link #11345
........
2011-02-27 15:09:14 +00:00
Giampaolo Rodolà 63390b3cbb Merged revisions 88581 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r88581 | giampaolo.rodola | 2011-02-25 15:50:57 +0100 (ven, 25 feb 2011) | 1 line

  (issue 11232) - fix asyncore documentation issue (patch by Sandro Tosi)
........
2011-02-25 14:55:52 +00:00
Georg Brandl 3c865231c1 Markup backport fix. 2011-02-25 11:27:48 +00:00
Georg Brandl 280460271d Merged revisions 87627,87638,87760,87986,88108,88115,88165,88263,88329,88364-88365,88423-88424 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r87627 | georg.brandl | 2011-01-02 15:23:43 +0100 (So, 02 Jan 2011) | 1 line

  #1665333: add more docs for optparse.OptionGroup.
........
  r87638 | georg.brandl | 2011-01-02 20:07:51 +0100 (So, 02 Jan 2011) | 1 line

  Fix code indentation.
........
  r87760 | georg.brandl | 2011-01-05 11:59:48 +0100 (Mi, 05 Jan 2011) | 1 line

  Fix duplicate end tag.
........
  r87986 | georg.brandl | 2011-01-13 08:31:18 +0100 (Do, 13 Jan 2011) | 1 line

  Fix the example output of count().
........
  r88108 | georg.brandl | 2011-01-19 09:42:03 +0100 (Mi, 19 Jan 2011) | 1 line

  Suppress trailing spaces in table paragraphs.
........
  r88115 | georg.brandl | 2011-01-19 21:05:49 +0100 (Mi, 19 Jan 2011) | 1 line

  #10944: add c_bool to types table.
........
  r88165 | georg.brandl | 2011-01-24 20:53:18 +0100 (Mo, 24 Jan 2011) | 1 line

  Typo fix.
........
  r88263 | georg.brandl | 2011-01-30 13:19:35 +0100 (So, 30 Jan 2011) | 1 line

  #10680: fix mutually exclusive arguments in argument groups.
........
  r88329 | georg.brandl | 2011-02-03 08:08:25 +0100 (Do, 03 Feb 2011) | 1 line

  Punctuation typos.
........
  r88364 | georg.brandl | 2011-02-07 13:10:46 +0100 (Mo, 07 Feb 2011) | 1 line

  #11138: fix order of fill and align specifiers.
........
  r88365 | georg.brandl | 2011-02-07 13:13:58 +0100 (Mo, 07 Feb 2011) | 1 line

  #8691: document that right alignment is default for numbers.
........
  r88423 | georg.brandl | 2011-02-15 13:41:17 +0100 (Di, 15 Feb 2011) | 1 line

  Apply logging SocketHandler doc update by Vinay.
........
  r88424 | georg.brandl | 2011-02-15 13:44:43 +0100 (Di, 15 Feb 2011) | 1 line

  Remove editing slip.
........
2011-02-25 11:01:04 +00:00
Georg Brandl 28dadd988b Merged revisions 87050,87101,87146,87156,87172,87175,87371,87378,87522-87524,87526,87530-87535 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r87050 | georg.brandl | 2010-12-04 18:09:30 +0100 (Sa, 04 Dez 2010) | 1 line

  Fix typo.
........
  r87101 | georg.brandl | 2010-12-06 23:02:48 +0100 (Mo, 06 Dez 2010) | 1 line

  Remove visible XXX comments.
........
  r87146 | georg.brandl | 2010-12-09 19:08:43 +0100 (Do, 09 Dez 2010) | 1 line

  Fix "seperate".
........
  r87156 | georg.brandl | 2010-12-10 11:01:44 +0100 (Fr, 10 Dez 2010) | 1 line

  #10668: fix wrong call of __init__.
........
  r87172 | georg.brandl | 2010-12-11 20:10:30 +0100 (Sa, 11 Dez 2010) | 1 line

  Avoid AttributeError(_closed) when a TemporaryDirectory is deallocated whose mkdtemp call failed.
........
  r87175 | georg.brandl | 2010-12-11 23:19:34 +0100 (Sa, 11 Dez 2010) | 1 line

  Fix markup.
........
  r87371 | georg.brandl | 2010-12-18 17:21:58 +0100 (Sa, 18 Dez 2010) | 1 line

  Fix typo.
........
  r87378 | georg.brandl | 2010-12-18 18:51:28 +0100 (Sa, 18 Dez 2010) | 1 line

  #10723: add missing builtin exceptions.
........
  r87522 | georg.brandl | 2010-12-28 10:16:12 +0100 (Di, 28 Dez 2010) | 1 line

  Replace sys.maxint mention by sys.maxsize.
........
  r87523 | georg.brandl | 2010-12-28 10:18:24 +0100 (Di, 28 Dez 2010) | 1 line

  Remove confusing paragraph -- this is relevant only to advanced users anyway and does not belong into the tutorial.
........
  r87524 | georg.brandl | 2010-12-28 10:29:19 +0100 (Di, 28 Dez 2010) | 1 line

  Fix advice: call PyType_Ready to fill in ob_type of custom types.
........
  r87526 | georg.brandl | 2010-12-28 11:38:33 +0100 (Di, 28 Dez 2010) | 1 line

  #10777: fix iteration over dict keys while mutating the dict.
........
  r87530 | georg.brandl | 2010-12-28 12:06:07 +0100 (Di, 28 Dez 2010) | 1 line

  #10767: update README in crashers; not all may have a bug entry and/or be fixed.
........
  r87531 | georg.brandl | 2010-12-28 12:08:17 +0100 (Di, 28 Dez 2010) | 1 line

  #10742: document readonly attribute of memoryviews.
........
  r87532 | georg.brandl | 2010-12-28 12:15:49 +0100 (Di, 28 Dez 2010) | 1 line

  #10781: clarify that *encoding* is not a parameter for Node objects in general.
........
  r87533 | georg.brandl | 2010-12-28 12:38:12 +0100 (Di, 28 Dez 2010) | 1 line

  Remove history; adapt a bit more to reST, since this will once be part of the dev guide.
........
  r87534 | georg.brandl | 2010-12-28 12:48:53 +0100 (Di, 28 Dez 2010) | 1 line

  Rewrap.
........
  r87535 | georg.brandl | 2010-12-28 12:49:41 +0100 (Di, 28 Dez 2010) | 1 line

  #10739: document that on Windows, socket.makefile() does not make a file that has a true file descriptor usable where such a thing is expected.
........
2011-02-25 10:50:32 +00:00
Georg Brandl 52f839540c Merged revisions 86881,86887,86913-86915,86933,86943,86960,86964,86974,86980,86996,87008 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86881 | georg.brandl | 2010-11-30 08:43:28 +0100 (Di, 30 Nov 2010) | 1 line

  #10584: fix bad links.
........
  r86887 | georg.brandl | 2010-11-30 15:57:54 +0100 (Di, 30 Nov 2010) | 1 line

  Fix typo.
........
  r86913 | georg.brandl | 2010-12-01 16:32:43 +0100 (Mi, 01 Dez 2010) | 1 line

  Add missing word, and add a better reference to the actual function.
........
  r86914 | georg.brandl | 2010-12-01 16:36:33 +0100 (Mi, 01 Dez 2010) | 1 line

  #10594: fix parameter names in PyList API docs.
........
  r86915 | georg.brandl | 2010-12-01 16:44:25 +0100 (Mi, 01 Dez 2010) | 1 line

  Fix some markup and style in the unittest docs.
........
  r86933 | georg.brandl | 2010-12-02 19:02:01 +0100 (Do, 02 Dez 2010) | 1 line

  #10597: fix Py_SetPythonHome docs by pointing to where the meaning of PYTHONHOME is already documented.
........
  r86943 | georg.brandl | 2010-12-02 23:35:25 +0100 (Do, 02 Dez 2010) | 1 line

  Re-add accidentally removed line.
........
  r86960 | georg.brandl | 2010-12-03 08:55:44 +0100 (Fr, 03 Dez 2010) | 1 line

  #10360: catch TypeError in WeakSet.__contains__, just like WeakKeyDictionary does.
........
  r86964 | georg.brandl | 2010-12-03 10:58:38 +0100 (Fr, 03 Dez 2010) | 1 line

  #10549: fix interface of docclass() for text documenter.
........
  r86974 | georg.brandl | 2010-12-03 16:30:09 +0100 (Fr, 03 Dez 2010) | 1 line

  Markup consistency fixes.
........
  r86980 | georg.brandl | 2010-12-03 18:19:27 +0100 (Fr, 03 Dez 2010) | 1 line

  Fix punctuation.
........
  r86996 | georg.brandl | 2010-12-03 20:56:42 +0100 (Fr, 03 Dez 2010) | 1 line

  Fix indentation.
........
  r87008 | georg.brandl | 2010-12-04 10:04:04 +0100 (Sa, 04 Dez 2010) | 1 line

  Fix typo.
........
2011-02-25 10:39:23 +00:00
Éric Araujo 8ff851b468 Link from deprecated sets module to builtins set and frozenset (#11238) 2011-02-18 17:47:23 +00:00
Raymond Hettinger 97b31954b7 Fix example for itertools.count(). 2011-02-14 06:03:41 +00:00
Georg Brandl ba516cb83e Fix markup problems. 2011-02-12 07:32:17 +00:00
R. David Murray 46c4e4709a Merged revisions 88402 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r88402 | r.david.murray | 2011-02-11 17:37:16 -0500 (Fri, 11 Feb 2011) | 2 lines

  Fix argument name typo in compileall docs.
........
2011-02-11 22:54:34 +00:00
R. David Murray 561b96f98c Merged revisions 86542,87136,87216,87221,87228,87256,87337-87338,87372,87516,87571,88164 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86542 | r.david.murray | 2010-11-19 22:48:58 -0500 (Fri, 19 Nov 2010) | 2 lines

  Make test class name unique so that both test classes run.
........
  r87136 | r.david.murray | 2010-12-08 17:53:00 -0500 (Wed, 08 Dec 2010) | 6 lines

  Have script_helper._assert_python strip refcount strings from stderr.

  This makes the output of the function and those that depend on it
  independent of whether or not they are being run under a debug
  build.
........
  r87216 | r.david.murray | 2010-12-13 17:50:30 -0500 (Mon, 13 Dec 2010) | 2 lines

  #10698: fix typo in example.
........
  r87221 | r.david.murray | 2010-12-13 19:55:46 -0500 (Mon, 13 Dec 2010) | 4 lines

  #10699: fix docstring for tzset: it does not take a parameter

  Thanks to Garrett Cooper for the fix.
........
  r87228 | r.david.murray | 2010-12-13 21:25:43 -0500 (Mon, 13 Dec 2010) | 2 lines

  Turn on regrtest -W (rerun immediately) option for Windows, too.
........
  r87256 | r.david.murray | 2010-12-14 21:19:14 -0500 (Tue, 14 Dec 2010) | 2 lines

  #10705: document what the values of debuglevel are and mean.
........
  r87337 | r.david.murray | 2010-12-17 11:11:40 -0500 (Fri, 17 Dec 2010) | 2 lines

  #10559: provide instructions for accessing sys.argv when first mentioned.
........
  r87338 | r.david.murray | 2010-12-17 11:29:07 -0500 (Fri, 17 Dec 2010) | 2 lines

  #10454: clarify the compileall docs and help messages.
  [changes to compileall.py were not backported, only the doc changes]
........
  r87372 | r.david.murray | 2010-12-18 11:39:06 -0500 (Sat, 18 Dec 2010) | 2 lines

  #10728: the default for printing help is sys.stdout, not stderr.
........
  r87516 | r.david.murray | 2010-12-27 15:09:32 -0500 (Mon, 27 Dec 2010) | 5 lines

  #7056: runtest and runtest_inner don't use testdir, so drop it from their sigs

  I've only tested regular runs and -j runs.  If I've broken anything
  else I'm sure I'll hear about it sooner or later.
........
  r87571 | r.david.murray | 2010-12-29 14:06:48 -0500 (Wed, 29 Dec 2010) | 2 lines

  Fix same typo in docs.
........
  r88164 | r.david.murray | 2011-01-24 14:34:58 -0500 (Mon, 24 Jan 2011) | 12 lines

  #10960: fix 'stat' links, link to lstat from stat, general tidy of stat doc.

  Original patch by Michal Nowikowski, with some additions and wording
  fixes by me.

  I changed the wording from 'Performs a stat system call' to 'Performs
  the equivalent of a stat system call', since on Windows there are no
  stat/lstat system calls involved.  I also extended Michal's breakout
  of the attributes into a list to the other paragraphs, and rearranged
  the order of the paragraphs in the 'stat' docs to make it flow
  better and put it in what I think is a more logical/useful order.
........
2011-02-11 17:25:54 +00:00
Antoine Pitrou e9bd9dbc73 Merged revisions 88371 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r88371 | antoine.pitrou | 2011-02-07 16:58:11 +0100 (lun., 07 févr. 2011) | 3 lines

  Clarify that IMAP4() implicitly calls open(), and that logout() implicitly calls shutdown().
........
2011-02-07 16:03:47 +00:00
Gregory P. Smith e3e967f2b3 Merged revisions 88352 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r88352 | gregory.p.smith | 2011-02-05 13:47:25 -0800 (Sat, 05 Feb 2011) | 3 lines

  issue7678 - Properly document how to replace a shell pipeline so that SIGPIPE
  happens when the end exits before the beginning.
........
2011-02-05 21:49:56 +00:00
Antoine Pitrou 893e7c6184 Merged revisions 88334 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r88334 | antoine.pitrou | 2011-02-04 21:11:11 +0100 (ven., 04 févr. 2011) | 3 lines

  Mention that seek and tell over a TextIOWrapper can be very slow.
........
2011-02-04 20:17:53 +00:00
Éric Araujo 54274ad96a Merged revisions 86236,86240,86332,86340,87271,87273,87447 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

To comply with the 2.x doc style, the methods in trace.rst use brackets around
optional arguments.  The rest is a mostly straight merge, modulo support changed
to test_support and use of the old super call style in test_tuple.

........
  r86236 | eric.araujo | 2010-11-06 03:44:43 +0100 (sam., 06 nov. 2010) | 2 lines

  Make sure each test can be run standalone (./python Lib/distutils/tests/x.py)
........
  r86240 | eric.araujo | 2010-11-06 05:11:59 +0100 (sam., 06 nov. 2010) | 2 lines

  Prevent ResourceWarnings in test_gettext
........
  r86332 | eric.araujo | 2010-11-08 19:15:17 +0100 (lun., 08 nov. 2010) | 4 lines

  Add missing NEWS entry for a fix committed by Senthil.

  All recent modifications to distutils should now be covered in NEWS.
........
  r86340 | eric.araujo | 2010-11-08 22:48:23 +0100 (lun., 08 nov. 2010) | 2 lines

  This was actually fixed for the previous alpha.
........
  r87271 | eric.araujo | 2010-12-15 20:09:58 +0100 (mer., 15 déc. 2010) | 2 lines

  Improve trace documentation (#9264).  Patch by Eli Bendersky.
........
  r87273 | eric.araujo | 2010-12-15 20:30:15 +0100 (mer., 15 déc. 2010) | 2 lines

  Use nested method directives, rewrap long lines, fix whitespace.
........
  r87447 | eric.araujo | 2010-12-23 20:13:05 +0100 (jeu., 23 déc. 2010) | 2 lines

  Fix typo in superclass method name
........
2011-02-03 00:12:18 +00:00
Brian Curtin 37c4a723a4 Merged revisions 88281 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r88281 | brian.curtin | 2011-01-31 13:35:02 -0600 (Mon, 31 Jan 2011) | 2 lines

  #11083 typo: RuntimeException -> RuntimeError
........
2011-01-31 19:55:14 +00:00
Vinay Sajip 2e88104780 Issue 11008: docs updated to show versionadded for dictConfig. 2011-01-27 19:14:16 +00:00
Raymond Hettinger 32074e337e Add note advising that 'filter' be used as a keyword-argument. 2011-01-26 20:40:32 +00:00
Terry Reedy 51581de168 Issue #11000 ast.parse doc fix (r88172) 2011-01-24 21:48:11 +00:00
Alexander Belopolsky 7e8fbd2b7d Merged revisions 88114 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r88114 | alexander.belopolsky | 2011-01-19 14:53:30 -0500 (Wed, 19 Jan 2011) | 5 lines

  Issue #10934: Fixed and expanded Internaldate2tuple() and
  Time2Internaldate() documentation.  Thanks Joe Peterson for the report
  and the original patch.
........
2011-01-19 21:48:20 +00:00
Eli Bendersky f274eea02c Issue #10902: Fix reference to run* methods 2011-01-14 07:50:27 +00:00
Georg Brandl 585bbb98a7 Merged revisions 87890 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r87890 | georg.brandl | 2011-01-09 10:04:08 +0100 (So, 09 Jan 2011) | 1 line

  Wrap some long examples and signatures.
........
2011-01-09 09:33:09 +00:00
Georg Brandl cbb2e49c3c Hand-port parts of r87789. 2011-01-09 08:04:37 +00:00