53 Commits

Author SHA1 Message Date
Emmanuel Arias
00eb063b66 bpo-41858: Clarify line in optparse doc (GH-22407)
The existing line is easily read as being incomplete.
2020-09-26 23:43:18 -04:00
Serhiy Storchaka
138ccbb022 bpo-38738: Fix formatting of True and False. (GH-17083)
* "Return true/false" is replaced with "Return ``True``/``False``"
  if the function actually returns a bool.
* Fixed formatting of some True and False literals (now in monospace).
* Replaced "True/False" with "true/false" if it can be not only bool.
* Replaced some 1/0 with True/False if it corresponds the code.
* "Returns <bool>" is replaced with "Return <bool>".
2019-11-12 16:57:03 +02:00
Andrés Delfino
d2b11af915 Remove duplicate "Reference Guide" in optparse.rst. (GH-10372) 2018-11-07 07:47:11 +02:00
Serhiy Storchaka
511747bec3 bpo-35110: Fix yet few spaces before dashes. (GH-10255) 2018-10-31 11:14:38 +02:00
Serhiy Storchaka
3f819ca138 bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231) 2018-10-31 02:26:06 +02:00
Andrés Delfino
5092439c2c bpo-33892: Doc: Use gender neutral words (GH-7770) 2018-06-18 13:34:30 +09:00
Leo Arias
c3d9508ff2 bpo-32746: Fix multiple typos (GH-5144)
Fix typos found by codespell in docs, docstrings, and comments.
2018-02-03 19:36:10 -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