Commit Graph

42 Commits

Author SHA1 Message Date
Petri Lehtinen 0b785036ef Issue #8890: Stop advertising an insecure use of /tmp in docs 2013-02-23 19:24:31 +01:00
Ezio Melotti ed3f5900d4 #15831: document multiple signatures on different lines. Patch by Chris Jerdonek. 2012-09-14 06:48:32 +03:00
R David Murray b9495c78a1 closes #5088: document behavior of optparse defaults with 'append' action. 2012-09-08 16:47:24 -04:00
Eli Bendersky 9efddb654b fixing typos in optparse doc 2011-11-16 06:01:14 +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
Eli Bendersky dedb502f90 Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen 2011-07-30 11:12:45 +03: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
Éric Araujo a8132ec27e Merged revisions 86521,86632,86823-86824,87294,87296,87300,87302 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86521 | eric.araujo | 2010-11-18 17:38:46 +0100 (jeu., 18 nov. 2010) | 17 lines

  Fix usage of :option: in the docs (#9312).

  :option: is used to create a link to an option of python, not to mark
  up any instance of any arbitrary command-line option.  These were
  changed to ````.

  For modules which do have a command-line interface, lists of options
  have been properly marked up with the program/cmdoption directives
  combo.  Options defined in such blocks can be linked to with :option:
  later in the same file, they won’t link to an option of python.

  Finally, the markup of command-line fragments in optparse.rst has
  been cleaned to use ``x`` instead of ``"x"``, keeping that latter
  form for actual Python strings.

  Patch by Eli Bendersky and Éric Araujo.
........
  r86632 | eric.araujo | 2010-11-21 04:09:17 +0100 (dim., 21 nov. 2010) | 2 lines

  Style edits in followup to r86521 (#9312)
........
  r86823 | eric.araujo | 2010-11-27 00:31:07 +0100 (sam., 27 nov. 2010) | 2 lines

  Use link-generating markup (see #9312)
........
  r86824 | eric.araujo | 2010-11-27 00:46:18 +0100 (sam., 27 nov. 2010) | 2 lines

  Rewrap long lines + minor edits
........
  r87294 | eric.araujo | 2010-12-16 01:07:01 +0100 (jeu., 16 déc. 2010) | 2 lines

  No need to generate a link for something that’s just above.
........
  r87296 | eric.araujo | 2010-12-16 01:23:30 +0100 (jeu., 16 déc. 2010) | 2 lines

  Advertise “python -m” instead of direct filename.
........
  r87300 | eric.araujo | 2010-12-16 02:40:26 +0100 (jeu., 16 déc. 2010) | 2 lines

  Advertise “python -m test” over test.regrtest (r87296 followup)
........
  r87302 | eric.araujo | 2010-12-16 03:10:11 +0100 (jeu., 16 déc. 2010) | 2 lines

  Add versionadded directive missing from r78983.
........
2010-12-16 03:53:53 +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
Georg Brandl 0347c71c5f Merged revisions 83385-83389,83391 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r83385 | georg.brandl | 2010-08-01 08:42:45 +0200 (So, 01 Aug 2010) | 1 line

  #8773: mailbox.py does not need to be executable.
........
  r83386 | georg.brandl | 2010-08-01 08:44:46 +0200 (So, 01 Aug 2010) | 1 line

  #8768: name test method properly so that it gets executed.
........
  r83387 | georg.brandl | 2010-08-01 08:53:28 +0200 (So, 01 Aug 2010) | 1 line

  #8735: better explain semantics of *values* argument for parse().
........
  r83388 | georg.brandl | 2010-08-01 09:48:43 +0200 (So, 01 Aug 2010) | 1 line

  #7395: fix traceback in do_add() when no stats are loaded.  Apply same fix for do_sort() and do_reverse().
........
  r83389 | georg.brandl | 2010-08-01 09:57:47 +0200 (So, 01 Aug 2010) | 1 line

  Small improvements to pstats browser: do not crash on reading invalid file, and actually do a reload when executing "read" as intended.
........
  r83391 | georg.brandl | 2010-08-01 10:10:08 +0200 (So, 01 Aug 2010) | 1 line

  Add another news entry.
........
2010-08-01 19:02:09 +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
Senthil Kumaran 67b4e187e1 Fixed Issue8209 - OptionParser keyword arg 'epilog' not mentioned in the docs 2010-03-23 08:46:31 +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
Ezio Melotti b9c3ed4f82 #3340: document print/get_usage and print/get_version 2010-01-04 21:43:02 +00:00
Ezio Melotti 5129ed38c3 #7618: fix highlight of code blocks 2010-01-03 09:01:27 +00:00
Georg Brandl 66d8d69cd8 #7404: remove reference to non-existing example files. 2009-12-28 08:48:24 +00:00
Georg Brandl b926ebb896 Make the optparse doc style a bit more standard: use standard description units for attrs/methods/etc., and use the correct referencing roles. 2009-09-17 17:14:04 +00:00
Georg Brandl 7842a41f5c Remove duplicate doc of enable/disable_interspersed_args. 2009-09-17 16:26:06 +00:00
Georg Brandl bc3777d85e String values should be shown with quotes, to avoid confusion with constants. 2009-09-17 10:23:02 +00:00
Georg Brandl 718b221e06 #6892: fix optparse example involving help option. 2009-09-16 13:11:06 +00:00
Georg Brandl d7226ffe0b Remove strange trailing commas. 2009-09-16 13:06:22 +00:00
Georg Brandl 8514b85edc #6638: fix wrong parameter name and markup a class. 2009-09-01 08:06:03 +00:00
Georg Brandl 9fa61bb37d #6577: fix (hopefully) all links to builtin instead of module/class-specific objects. 2009-07-26 14:19:57 +00:00
Georg Brandl 0c9eb43149 #6371: fix link targets. 2009-06-30 16:35:11 +00:00
Georg Brandl 14315d6513 #6009: undocument default argument of Option as deprecated. 2009-05-16 11:18:55 +00:00
Georg Brandl 253a29fa4d #4827: fix callback example. 2009-02-05 11:33:21 +00:00
Georg Brandl 174fbe7742 #5153: fix typo in example. 2009-02-05 10:30:57 +00:00
Georg Brandl 7044b11818 Remove tabs from the documentation. 2009-01-03 21:04:55 +00:00
Georg Brandl c62ef8b4d9 Remove trailing whitespace. 2009-01-03 20:55:06 +00:00
Georg Brandl 60b2e38b68 #4568: remove limitation in varargs callback example. 2008-12-15 09:07:39 +00:00
Andrew M. Kuchling cad8da8abd Markup fixes. (optparse.rst probably needs an entire revision pass.) 2008-09-30 13:01:46 +00:00
Andrew M. Kuchling 7a4a93b8e9 #1415508: Document two functions 2008-09-28 01:08:47 +00:00
Mark Summerfield ffde3cfcb1 Added xrefs to each other. 2008-09-08 14:45:37 +00:00
Andrew M. Kuchling 810f807b1b #3040: include 'dest' argument in example; trim some trailing whitespace 2008-09-06 13:04:02 +00:00
Georg Brandl 60c0be3acd Clarification. 2008-06-13 13:26:54 +00:00
Benjamin Peterson c8590944e5 #2673 Fix example typo in optparse docs 2008-04-23 20:38:06 +00:00
Georg Brandl 799b372f31 #2476: document that %default feature is new in 2.4. 2008-03-25 08:39:10 +00:00
Georg Brandl 12db865a64 Part of #2154: minimal syntax fixes in doc example snippets. 2008-02-21 20:38:13 +00:00
Andrew M. Kuchling 8b506e7a2d Bug 1296: restore text describing OptionGroup 2008-01-19 21:00:38 +00:00
Georg Brandl b19be571e0 Some cleanup in the docs. 2007-12-29 10:57:00 +00:00
Georg Brandl 97ca58370a Fix typo and double word. 2007-09-24 17:55:47 +00:00
Georg Brandl 8ec7f65613 Move the 2.6 reST doc tree in place. 2007-08-15 14:28:01 +00:00