Commit Graph

38 Commits

Author SHA1 Message Date
Sandro Tosi cb21227407 Issue #13605: more meaningful example + fixes 2012-01-19 22:22:35 +01:00
Sandro Tosi 10f047dca8 Issue #13605: add documentation for nargs=argparse.REMAINDER 2012-01-19 21:59:34 +01:00
Sandro Tosi 8b211fc123 Issue #10772: add count and help argparse action; patch by Marc Sibson 2012-01-04 23:24:48 +01:00
Sandro Tosi 711f54798c Issue #9349: add argparse.SUPPRESS to help doc 2012-01-03 18:31:51 +01:00
Raymond Hettinger 421467f8f0 Note the store_true and store_false also create the appropriate defaults. 2011-11-20 11:05:23 -08:00
Eli Bendersky bba1dd5332 Issue #13191: typo in argparse docs 2011-11-11 16:42:11 +02:00
Éric Araujo 7ce05e07c0 Fix some markup and one typo 2011-09-01 19:54:05 +02:00
Éric Araujo 29a0b57e4e Backport source links from 3.x.
Existing links have been updated to use the new reST role.  In some
files, I have also made cosmetic changes to the header.
2011-08-19 02:14:03 +02:00
Éric Araujo 67719bde07 Synchronize argparse docs with 3.x versions 2011-08-19 02:00:07 +02:00
Senthil Kumaran c1ee4ef9dc Fix closes issue12663 - Correcting the ArgumentParser.error description. Patch by Sandro Tosi. 2011-08-03 07:43:52 +08:00
Éric Araujo f0d44bccb7 Add a link target for argparse.Namespace (#8982) 2011-07-29 17:59:17 +02:00
Ezio Melotti c69313a7ab Fix some more markup glitches in argparse doc. 2011-04-22 01:29:13 +03:00
Ezio Melotti 569083adbf The \ is not supported in Sphinx 0.6. 2011-04-21 23:30:27 +03:00
Ezio Melotti d281f1439d #11905: fix missing full stop in argparse doc. Noticed by Vladimir Rutsky. 2011-04-21 23:09:27 +03:00
Ezio Melotti 310619c80f #11904: fix indentation in argparse doc. Noticed by Vladimir Rutsky. 2011-04-21 23:06:48 +03:00
Ezio Melotti 0a43ecc9df #11902: Fix typo in argparse doc. Noticed by Vladimir Rutsky. 2011-04-21 22:56:51 +03:00
Ezio Melotti 01b600c2a3 Add the :mod: role where it was missing. 2011-04-21 16:12:17 +03:00
Ezio Melotti 2eab88e834 #11885: capitalize Python. 2011-04-21 15:26:46 +03:00
Ezio Melotti 12125823fa Fix a few hyphens in argparse.rst. 2011-04-16 23:04:51 +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
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
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 b8d0e365e2 Merged revisions 85617-85622,85624,85626-85627,85629,85631,85635-85636,85638-85639,85641-85642 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r85617 | georg.brandl | 2010-10-17 12:09:06 +0200 (So, 17 Okt 2010) | 1 line

  #5212: md5 weaknesses do not affect hmac, so remove the note about that.
........
  r85618 | georg.brandl | 2010-10-17 12:14:38 +0200 (So, 17 Okt 2010) | 1 line

  #9086: correct wrong terminology about linking with pythonXY.dll.
........
  r85619 | georg.brandl | 2010-10-17 12:15:50 +0200 (So, 17 Okt 2010) | 1 line

  Make file names consistent.
........
  r85620 | georg.brandl | 2010-10-17 12:22:28 +0200 (So, 17 Okt 2010) | 1 line

  Remove second parser module example; it referred to non-readily-available example files, and this kind of discovery is much better done with the AST nowadays anyway.
........
  r85621 | georg.brandl | 2010-10-17 12:24:54 +0200 (So, 17 Okt 2010) | 1 line

  #9105: move pickle warning to a bit more prominent location.
........
  r85622 | georg.brandl | 2010-10-17 12:28:04 +0200 (So, 17 Okt 2010) | 1 line

  #9112: document error() and exit() methods of ArgumentParser.
........
  r85624 | georg.brandl | 2010-10-17 12:34:28 +0200 (So, 17 Okt 2010) | 1 line

  Some markup and style fixes in argparse docs.
........
  r85626 | georg.brandl | 2010-10-17 12:38:20 +0200 (So, 17 Okt 2010) | 1 line

  #9117: fix syntax for class definition.
........
  r85627 | georg.brandl | 2010-10-17 12:44:11 +0200 (So, 17 Okt 2010) | 1 line

  #9138: reword introduction to classes in Python.
........
  r85629 | georg.brandl | 2010-10-17 12:51:45 +0200 (So, 17 Okt 2010) | 1 line

  #5962: clarify sys.exit() vs. threads.
........
  r85631 | georg.brandl | 2010-10-17 12:53:54 +0200 (So, 17 Okt 2010) | 1 line

  Fix capitalization.
........
  r85635 | georg.brandl | 2010-10-17 13:03:22 +0200 (So, 17 Okt 2010) | 1 line

  #5121: fix claims about default values leading to segfaults.
........
  r85636 | georg.brandl | 2010-10-17 13:06:14 +0200 (So, 17 Okt 2010) | 1 line

  #9237: document sys.call_tracing().
........
  r85638 | georg.brandl | 2010-10-17 13:13:37 +0200 (So, 17 Okt 2010) | 1 line

  Port changes to pickle docs apparently lost in py3k.
........
  r85639 | georg.brandl | 2010-10-17 13:23:56 +0200 (So, 17 Okt 2010) | 1 line

  Make twisted example a bit more logical.
........
  r85641 | georg.brandl | 2010-10-17 13:29:07 +0200 (So, 17 Okt 2010) | 1 line

  Fix documentation of dis.opmap direction.
........
  r85642 | georg.brandl | 2010-10-17 13:36:28 +0200 (So, 17 Okt 2010) | 1 line

  #9730: fix example.
........
2010-11-26 07:53:50 +00:00
Georg Brandl 35e7a8fa53 Merged revisions 85274 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r85274 | georg.brandl | 2010-10-06 12:26:05 +0200 (Mi, 06 Okt 2010) | 1 line

  Fix errors found by "make suspicious".
........
2010-10-06 10:41:31 +00:00
R. David Murray 1cbf78e040 Merged revisions 83675 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r83675 | r.david.murray | 2010-08-03 13:56:09 -0400 (Tue, 03 Aug 2010) | 12 lines

  #9444: use first of prefix_chars for help opt instead of raising error

  An argparse option parser created with a prefix_chars that did not
  include a '-' would happily add -h and --help options, and then throw
  an error when it tried to format the help because the - was an invalid
  prefix character.  This patch makes it use the first character of
  prefix_chars as the character for the help options if and only if '-'
  is not one of the valid prefix_chars.

  Fix by Theodore Turocy, unit tests by Catherine Devlin.
........
2010-08-03 18:14:01 +00:00
Georg Brandl 8891e23c15 Merged revisions 83160-83161,83166,83168-83169,83171 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r83160 | georg.brandl | 2010-07-26 10:51:42 +0200 (Mo, 26 Jul 2010) | 1 line

  #9381: fix markup.
........
  r83161 | georg.brandl | 2010-07-26 11:33:12 +0200 (Mo, 26 Jul 2010) | 1 line

  Add Brian Quinlan.
........
  r83166 | georg.brandl | 2010-07-26 17:11:49 +0200 (Mo, 26 Jul 2010) | 1 line

  Fix grammar.
........
  r83168 | georg.brandl | 2010-07-26 19:00:20 +0200 (Mo, 26 Jul 2010) | 1 line

  Fix indentation in example.
........
  r83169 | georg.brandl | 2010-07-26 19:09:32 +0200 (Mo, 26 Jul 2010) | 1 line

  Add Reid.
........
  r83171 | georg.brandl | 2010-07-26 23:12:13 +0200 (Mo, 26 Jul 2010) | 1 line

  Clarify.
........
2010-08-01 21:23:50 +00:00
Georg Brandl 58df679b5e Add missing target. 2010-07-03 10:25:47 +00:00
Steven Bethard 74bd9cf7d0 argparse documentation updates (including updates to optparse and getopt documentation that were promised in the PEP) 2010-05-24 02:38:00 +00:00
Ezio Melotti 019551fa1b Fix typo in argparse doc. 2010-05-19 00:32:52 +00:00
Georg Brandl 404bd7f473 #8528: fix typo. 2010-04-25 10:16:00 +00:00
Georg Brandl 21e99f4924 #5341: more built-in vs builtin fixes. 2010-03-07 15:23:59 +00:00
Benjamin Peterson ac80c157c7 rephrase 2010-03-03 21:28:25 +00:00
Benjamin Peterson c516d199ec fix Sphinx warnings 2010-03-03 02:04:24 +00:00
Benjamin Peterson 90c5802e6b edit for style 2010-03-03 01:55:09 +00:00
Georg Brandl d2decd9965 Add some x-refs. 2010-03-02 22:17:38 +00:00
Benjamin Peterson a39e966e97 set svn:eol-style 2010-03-02 22:05:59 +00:00
Steven Bethard e9330e7941 Initial commit of the argparse library, based on argparse 1.1.
Docs still need some updating to make getopt and optparse match the wording promised in the PEP.
There are also probably a number of :class:ArgumentParser etc. links that could be added to the argparse documentation.
2010-03-02 08:38:09 +00:00