diff options
| author | Dan Sully <daniel-github@electricrain.com> | 2018-08-27 07:58:30 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-08-27 07:58:30 -0700 |
| commit | fb3e9d2edb95c3ac5e77071e7efeb3f42c53a37e (patch) | |
| tree | 64a26f4e6c6565c7ba0fd066aa914cee41af5e66 /docs | |
| parent | c2ad12138e24df63ed08d60b4304727e9b752db0 (diff) | |
| parent | 09b672b352864d53a4222ba1b29c551bf78d8f77 (diff) | |
| download | click-fb3e9d2edb95c3ac5e77071e7efeb3f42c53a37e.tar.gz | |
Merge pull request #1055 from ZenithDK/patch-1
Document automatic lowercasing of parameter names
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/parameters.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/parameters.rst b/docs/parameters.rst index b7e2124..112e8fa 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -91,11 +91,14 @@ If all names for a parameter contain dashes, the internal name is generated automatically by taking the longest argument and converting all dashes to underscores. +The internal name is converted to lowercase. + Examples: * For an option with ``('-f', '--foo-bar')``, the parameter name is `foo_bar`. * For an option with ``('-x',)``, the parameter is `x`. * For an option with ``('-f', '--filename', 'dest')``, the parameter name is `dest`. +* For an option with ``('--CamelCaseOption',)``, the parameter is `camelcaseoption`. * For an arguments with ``(`foogle`)``, the parameter name is `foogle`. To provide a different human readable name for use in help text, see the section about :ref:`doc-meta-variables`. |