[Python-checkins] cpython (3.2): Use real word in English text (i.e. not code)

[Terry Reedy]

On 8/12/2011 12:03 PM, eric.araujo wrote:
> http://hg.python.org/cpython/rev/d79b2ce01438
> changeset:   71827:d79b2ce01438
> branch:      3.2
> user:        Éric Araujo<merwok at netwok.org>
> date:        Wed Aug 10 04:19:03 2011 +0200
> summary:
>    Use real word in English text (i.e. not code)

I agree that 'arg' for 'argument is email/twitter-speak, not proper 
document prose.

> diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst

> -   :synopsis: Command-line option and argument-parsing library.
> +   :synopsis: Command-line option and argument parsing library.

However, 'argument-parsing' could/should be left hyphenated as a 
compound adjective for the same reason 'command-line' is.

> -:class:`ArgumentParser` parses args through the
> +:class:`ArgumentParser` parses arguments through the
>   :meth:`~ArgumentParser.parse_args` method.  This will inspect the command line,
>   convert each arg to the appropriate type and then invoke the appropriate action.

An arg you missed

> -If the ``nargs`` keyword argument is not provided, the number of args consumed
> +If the ``nargs`` keyword argument is not provided, the number of arguments consumed
>   is determined by the action_.  Generally this means a single command-line arg

Another. Args are as pesky as bugs.

> -  argument that can be followed by zero or one command-line args.
> +  argument that can be followed by zero or one command-line arguments.
>     When parsing the command line, if the option string is encountered with no
>     command-line arg following it, the value of ``const`` will be assumed instead.

arg

> -necessary type-checking and type-conversions to be performed.  Common built-in
> +necessary type-checking and type conversions to be performed.  Common built-in

Right, 'type-conversion' is not an compound adjective here.

> -Some command-line args should be selected from a restricted set of values.
> +Some command-line arguments should be selected from a restricted set of values.
>   These can be handled by passing a container object as the ``choices`` keyword
>   argument to :meth:`~ArgumentParser.add_argument`.  When the command line is
>   parsed, arg values will be checked, and an error message will be displayed if

arg

It looks you did a global / args/ arguments/ but not / arg / argument /.

Terry