Skip to content

Commit 952180a

Browse files
committed
Tuned docs
1 parent 7307852 commit 952180a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/guide.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ There are two types of arguments --- thake an example:
1010
1111
ls -l --sort time /home
1212

13-
* Optional arguments (``-l``, ``--sort``) and
14-
* positional arguments (``/home``).
13+
* Optional arguments are ``-l`` and ``--sort``, while we have only one
14+
* positional argument --- ``/home``.
1515

16-
Here, the argument ``-l`` is optional of a boolean type (it is either on or off), ``--sort`` is also optional, taking exactly one value (in this case ``auto``, the equal sign acts as a delimiter).
16+
Here, the argument ``-l`` is optional of a boolean type (it is either on or off), ``--sort`` is also optional, taking exactly one value (in this case ``time``).
1717
``-l`` and ``--sort`` are called options, hence the name *optional* arguments.
1818
The common pattern is that optional arguments are not required, being there just for the case you need them.
1919

0 commit comments

Comments
 (0)