Deprecate multi-character short flags (#1718)

tj · Apr 18, 2022 · acbbe18 · acbbe18
1 parent 6c26370
commit acbbe18
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/deprecated.md b/docs/deprecated.md
@@ -13,6 +13,7 @@ They are currently still available for backwards compatibility, but should not b
   - [.command('*')](#command)
   - [cmd.description(cmdDescription, argDescriptions)](#cmddescriptioncmddescription-argdescriptions)
   - [InvalidOptionArgumentError](#invalidoptionargumenterror)
+  - [Short option flag longer than a single character](#short-option-flag-longer-than-a-single-character)
 
 ## RegExp .option() parameter
 
@@ -183,3 +184,9 @@ function myParseInt(value, dummyPrevious) {
 ```
 
 Deprecated from Commander v8.
+
+## Short option flag longer than a single character
+
+Short option flags like `-ws` were never supported, but the old README did not make this clear. The README now states that short options are a single character.
+
+README updated in Commander v3. Deprecated from Commander v9.