Skip to content

Commit

Permalink
Merge pull request #1055 from ZenithDK/patch-1
Browse files Browse the repository at this point in the history
Document automatic lowercasing of parameter names
  • Loading branch information
Dan Sully authored Aug 27, 2018
2 parents c2ad121 + 09b672b commit fb3e9d2
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit fb3e9d2

Please sign in to comment.