diff options
| author | Brandon W Maister <quodlibetor@gmail.com> | 2014-07-01 19:48:58 -0400 |
|---|---|---|
| committer | Brandon W Maister <quodlibetor@gmail.com> | 2014-07-01 19:50:49 -0400 |
| commit | b685eeacba7372834fc31836942e01026287f12b (patch) | |
| tree | ec8251b6583387b73aee7a0353973bc485a5de82 /docs/arguments.rst | |
| parent | a85c5b7e3275d49108701397aa93c7fd26b9e42b (diff) | |
| download | click-b685eeacba7372834fc31836942e01026287f12b.tar.gz | |
Add links from options -> arguments and back again
This helps draw the distinction between arguments and options, which
probably isn't familiar to people coming from argparse.
Diffstat (limited to 'docs/arguments.rst')
| -rw-r--r-- | docs/arguments.rst | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/arguments.rst b/docs/arguments.rst index 4c9cdef..e224d0a 100644 --- a/docs/arguments.rst +++ b/docs/arguments.rst @@ -1,12 +1,15 @@ +.. _arguments: + Arguments ========= .. currentmodule:: click -Arguments work similarly to options but are positional. They also only -support a subset of the features of options due to their syntactical nature. -Click will also not attempt to document arguments for you and wants you to -document them manually in order to avoid ugly help pages. +Arguments work similarly to :ref:`options <options>` but are positional. +They also only support a subset of the features of options due to their +syntactical nature. Click will also not attempt to document arguments for +you and wants you to document them manually in order to avoid ugly help +pages. Basic Arguments --------------- |