Browse files

add parameter note to aliases help

the form of parameters (no leading '-', etc.) is explained in the
key-value section help, but this is not printed unless '--help-all' is given, so the explanation is added to aliases as well.
  • Loading branch information...
1 parent 358f743 commit 1fc159c5334d41e121770954f8cd4338302dfbc1 @minrk committed Jul 6, 2011
Showing with 9 additions and 4 deletions.
  1. +9 −4 IPython/config/application.py
View
13 IPython/config/application.py
@@ -51,20 +51,25 @@
modes that involve setting multiple options together.
Flags *always* begin with '--', never just one '-'.
-""".strip() # trim newlines of front and back
+""".strip() # trim newlines off front and back
alias_description = """
These are commonly set parameters, given abbreviated aliases for convenience.
They are set in the same `name=value` way as class parameters, where
<name> is replaced by the real parameter for which it is an alias.
-""".strip() # trim newlines of front and back
+
+Setting parameters will *never* be prefixed with '-'.
+
+This line is evaluated in Python, so simple expressions are allowed, e.g.
+ `C.a=range(3)` For setting C.a=[0,1,2]
+""".strip() # trim newlines off front and back
keyvalue_description = """
Parameters are set from command-line arguments of the form:
`Class.trait=value`. Parameters will *never* be prefixed with '-'.
This line is evaluated in Python, so simple expressions are allowed, e.g.
- `C.a='range(3)'` For setting C.a=[0,1,2]
-""".strip() # trim newlines of front and back
+ `C.a=range(3)` For setting C.a=[0,1,2]
+""".strip() # trim newlines off front and back
#-----------------------------------------------------------------------------
# Application class

0 comments on commit 1fc159c

Please sign in to comment.