.alias({}) behaves differently based on mapping direction when genera…

…ting descriptions
yargs · Jul 20, 2013 · 37fea04 · 37fea04
1 parent 855b20d
commit 37fea04
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/readme.markdown b/readme.markdown
@@ -289,6 +289,8 @@ Set key names as equivalent such that updates to a key will propagate to aliases
 and vice-versa.
 
 Optionally `.alias()` can take an object that maps keys to aliases.
+Each key of this object should be the canonical version of the option, and each
+value should be a string or an array of strings.
 
 .default(key, value)
 --------------------