Skip to content

Commit f5eb99f

Browse files
committed
Merge pull request realpython#426 from Locker537/cli_fixes
Minor improvements to 'Command Line Applications' docs
2 parents 838bf1f + 540e444 commit f5eb99f

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/scenarios/cli.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
1-
Command Line Applications
1+
Command-line Applications
22
=========================
33

4-
.. todo:: Explain "Command Line Applications"
4+
.. todo:: Explain "Command-line Applications"
55

66
Clint
77
-----
88

9-
`clint <https://pypi.python.org/pypi/clint/>`_ is a python module which is
10-
filled with very useful tools for developing commandline applications.
9+
`clint <https://pypi.python.org/pypi/clint/>`_ is a python module which is
10+
filled with very useful tools for developing command-line applications.
1111
It supports features such as; CLI Colors and Indents, Simple and Powerful
1212
Column Printer, Iterator based progress bar and Implicit argument handling.
1313

1414
Click
1515
-----
1616

17-
`click <http://click.pocoo.org/>`_ is an upcoming Python package for creating command
18-
line interfaces in a composable way with as little amount of code as
19-
necessary. It’s the “Command Line Interface Creation Kit”. It’s highly
17+
`click <http://click.pocoo.org/>`_ is an upcoming Python package for creating
18+
command-line interfaces in a composable way with as little amount of code as
19+
necessary. It’s the “Command-line Interface Creation Kit”. It’s highly
2020
configurable but comes with good defaults out of the box.
2121

2222
docopt
2323
------
2424

2525
`docopt <http://docopt.org/>`_ is a lightweight, highly Pythonic package that
26-
allows creating command line interfaces easily and intuitively, by parsing
26+
allows creating command-line interfaces easily and intuitively, by parsing
2727
POSIX-style usage instructions.
2828

2929
Plac
3030
------
3131

32-
`Plac <https://pypi.python.org/pypi/plac>`_ is a python module that allows developing command line applications. In fact
33-
plac is a simple wrapper over the python standard library `argparse <http://docs.python.org/2/library/argparse.html>`_, it hides most of its
34-
complexity by using a declarative interface: the argument parser is inferred
32+
`Plac <https://pypi.python.org/pypi/plac>`_ is a python module that allows developing command-line applications. In fact
33+
plac is a simple wrapper over the python standard library `argparse <http://docs.python.org/2/library/argparse.html>`_, it hides most of its
34+
complexity by using a declarative interface: the argument parser is inferred
3535
rather than written down by imperatively. It is targetting especially unsophisticated
3636
users, programmers, sys-admins, scientists and in general people writing throw-away
3737
scripts for themselves, choosing the command-line interface because it is quick
@@ -40,7 +40,7 @@ and simple.
4040
Cliff
4141
------
4242

43-
`Cliff <https://cliff.readthedocs.org/en/latest>`_ is a framework for building command line programs.
43+
`Cliff <https://cliff.readthedocs.org/en/latest>`_ is a framework for building command-line programs.
4444
It uses setuptools entry points to provide subcommands, output formatters, and other extensions. The framework
45-
is meant to be used to create multi-level commands such as subversion and git, where the main program handles
45+
is meant to be used to create multi-level commands such as subversion and git, where the main program handles
4646
some basic argument parsing and then invokes a sub-command to do the work.

0 commit comments

Comments
 (0)