Commit Graph

48 Commits

Author SHA1 Message Date
Miss Islington (bot)
5f165851b9 bpo-33892: Doc: Use gender neutral words (GH-7770)
(cherry picked from commit 5092439c2c)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-17 21:49:43 -07:00
Miss Islington (bot)
e86db34dd3 [3.7] bpo-32746: Fix multiple typos (GH-5144) (GH-5520)
Fix typos found by codespell in docs, docstrings, and comments.
(cherry picked from commit c3d9508ff2)

Co-authored-by: Leo Arias <leo.arias@canonical.com>
2018-02-03 20:41:43 -05:00
Serhiy Storchaka
ecf41da83e Issue #19795: Mark up None as literal text. 2016-10-19 16:29:26 +03:00
Martin Panter
1050d2d0c7 Issue #26462: Doc: reduce literal_block warnings, fix syntax highlighting.
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
Terry Jan Reedy
fa089b9b0b Issue #22558: Add remaining doc links to source code for Python-coded modules.
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Serhiy Storchaka
dba903993a Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
Martin Panter
7462b64911 Issue #25523: Correct "a" article to "an" article
This changes the main documentation, doc strings, source code comments, and a
couple error messages in the test suite. In some cases the word was removed
or edited some other way to fix the grammar.
2015-11-02 03:37:02 +00:00
Georg Brandl
df48b97855 Fix a few scoping issues with versionadded/versionchanged directives. 2014-03-24 09:06:18 +01:00
Petri Lehtinen
9f74c6cf7d Issue #8890: Stop advertising an insecure use of /tmp in docs 2013-02-23 19:27:49 +01: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
14d66a98ed #5088: document behavior of optparse defaults with 'append' action. 2012-09-08 16:45:35 -04:00
Eli Bendersky
eeae1498aa fixing typos in optparse doc 2011-11-16 06:02:21 +02:00
Éric Araujo
19f9b71ffe Add a few missing source links from 2.7 and harmonize lib docs headers 2011-08-19 00:49:18 +02:00
Eli Bendersky
e250358062 Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen 2011-07-30 11:14:32 +03:00
Raymond Hettinger
469271d4ea More source links 2011-01-27 20:38:46 +00:00
Georg Brandl
121ff8235b #1665333: add more docs for optparse.OptionGroup. 2011-01-02 14:23:43 +00:00
Éric Araujo
713d3039dc 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.
2010-11-18 16:38:46 +00:00
Georg Brandl
682d7e0e07 Fix errors found by "make suspicious". 2010-10-06 10:26:05 +00:00
Georg Brandl
0941012325 #8735: better explain semantics of *values* argument for parse(). 2010-08-01 06:53:28 +00:00
Steven Bethard
5971096472 Merged revisions 81490 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r81490 | steven.bethard | 2010-05-23 19:38:00 -0700 (Sun, 23 May 2010) | 1 line

  argparse documentation updates (including updates to optparse and getopt documentation that were promised in the PEP)
........
2010-05-24 03:21:08 +00:00
Senthil Kumaran
5b58f5e509 Merged revisions 79329 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r79329 | senthil.kumaran | 2010-03-23 14:16:31 +0530 (Tue, 23 Mar 2010) | 2 lines

  Fixed Issue8209 - OptionParser keyword arg 'epilog' not mentioned in the docs
........
2010-03-23 11:00:53 +00:00
Steven Bethard
6d265699e6 Merged revisions 78576 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r78576 | steven.bethard | 2010-03-02 00:38:09 -0800 (Tue, 02 Mar 2010) | 3 lines

  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 09:22:57 +00:00
Ezio Melotti
1ce43198a0 Merged revisions 77306 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r77306 | ezio.melotti | 2010-01-04 23:43:02 +0200 (Mon, 04 Jan 2010) | 1 line

  #3340: document print/get_usage and print/get_version
........
2010-01-04 21:53:17 +00:00
Ezio Melotti
383ae95d72 Merged revisions 77267 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r77267 | ezio.melotti | 2010-01-03 11:01:27 +0200 (Sun, 03 Jan 2010) | 1 line

  #7618: fix highlight of code blocks
........
2010-01-03 09:06:02 +00:00
Benjamin Peterson
1baf465d27 Merged revisions 76847,76851,76869,76882,76891-76892,76924,77007,77070,77092,77096,77120,77126,77155 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r76847 | benjamin.peterson | 2009-12-14 21:25:27 -0600 (Mon, 14 Dec 2009) | 1 line

  adverb
........
  r76851 | benjamin.peterson | 2009-12-15 21:28:52 -0600 (Tue, 15 Dec 2009) | 1 line

  remove lib2to3 resource
........
  r76869 | vinay.sajip | 2009-12-17 08:52:00 -0600 (Thu, 17 Dec 2009) | 1 line

  Issue #7529: logging: Minor correction to documentation.
........
  r76882 | georg.brandl | 2009-12-19 11:30:28 -0600 (Sat, 19 Dec 2009) | 1 line

  #7527: use standard versionadded tags.
........
  r76891 | georg.brandl | 2009-12-19 12:16:31 -0600 (Sat, 19 Dec 2009) | 1 line

  #7479: add note about function availability on Unices.
........
  r76892 | georg.brandl | 2009-12-19 12:20:18 -0600 (Sat, 19 Dec 2009) | 1 line

  #7480: remove tautology.
........
  r76924 | georg.brandl | 2009-12-20 08:28:05 -0600 (Sun, 20 Dec 2009) | 1 line

  Small indentation fix.
........
  r77007 | gregory.p.smith | 2009-12-23 03:31:11 -0600 (Wed, 23 Dec 2009) | 3 lines

  Fix possible integer overflow in lchown and fchown functions.  For issue1747858.
........
  r77070 | amaury.forgeotdarc | 2009-12-27 14:06:44 -0600 (Sun, 27 Dec 2009) | 2 lines

  Fix a typo in comment
........
  r77092 | georg.brandl | 2009-12-28 02:48:24 -0600 (Mon, 28 Dec 2009) | 1 line

  #7404: remove reference to non-existing example files.
........
  r77096 | benjamin.peterson | 2009-12-28 14:51:17 -0600 (Mon, 28 Dec 2009) | 1 line

  document new fix_callable behavior
........
  r77120 | georg.brandl | 2009-12-29 15:09:17 -0600 (Tue, 29 Dec 2009) | 1 line

  #7595: fix typo in argument default constant.
........
  r77126 | amaury.forgeotdarc | 2009-12-29 17:06:17 -0600 (Tue, 29 Dec 2009) | 2 lines

  #7579: Add docstrings to the msvcrt module
........
  r77155 | georg.brandl | 2009-12-30 13:03:00 -0600 (Wed, 30 Dec 2009) | 1 line

  We only support Windows NT derivatives now.
........
2009-12-31 03:11:23 +00:00