Commit Graph

18 Commits

Author SHA1 Message Date
Serhiy Storchaka 12d547a80d Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 13:45:32 +03:00
Éric Araujo 69d096597d Fix note markup (#16805).
Patch by Tshepang Lekhonkhobe, reviewed by Georg Brandl.
2014-03-12 19:35:54 -04:00
Andrew Svetlov 1625d88709 Issue #16341: convert examples to use except ... as ... syntax. 2012-10-30 21:56:43 +02:00
Sandro Tosi 98ed08f24e update to new C roles and directives 2012-01-14 16:42:02 +01:00
Éric Araujo 0f697b300c Remove outdated pointer to optparse (fixes #11360).
The doc already points to argparse.
2011-08-26 16:38:40 +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 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
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
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
Georg Brandl d1bed8e5ef #6977: getopt does not support optional option arguments. 2009-10-22 15:54:35 +00:00
Benjamin Peterson a7b55a33f8 revert r69777 since all the experts agree that extra import lines distract from the code 2009-02-20 03:31:23 +00:00
Jeroen Ruigrok van der Werven 5149742e8b Since we recommend one module per import line, reflect this also in the
documentation.
2009-02-19 18:52:21 +00:00
Georg Brandl 8d6c49047f Use markup. 2008-12-05 09:13:45 +00:00
Mark Summerfield ffde3cfcb1 Added xrefs to each other. 2008-09-08 14:45:37 +00:00
Georg Brandl e8f1b00372 Enable doctest running for several other documents.
We have now over 640 doctests that are run with "make doctest".
2008-03-22 22:04:10 +00:00
Georg Brandl 27a2d1332b Fix introductory sentence. 2008-01-06 17:21:00 +00:00
Georg Brandl b19be571e0 Some cleanup in the docs. 2007-12-29 10:57:00 +00:00
Georg Brandl 8ec7f65613 Move the 2.6 reST doc tree in place. 2007-08-15 14:28:01 +00:00