Lesson
When adding a new CLI flag, do not add an abbreviated (short) form (e.g. -o) unless the user explicitly requests it.
Context
In PR #, an --output-file option was added to usethis tool requirements.txt and an uninstructed -o short form was included alongside it (see src/usethis/_ui/options.py). The reviewer had to explicitly request its removal.
Impact
Unsolicited short flags increase the CLI surface area, can conflict with future flags, and do not match user intent. Only add abbreviated forms when explicitly asked to do so.
Lesson
When adding a new CLI flag, do not add an abbreviated (short) form (e.g.
-o) unless the user explicitly requests it.Context
In PR #, an
--output-fileoption was added tousethis tool requirements.txtand an uninstructed-oshort form was included alongside it (seesrc/usethis/_ui/options.py). The reviewer had to explicitly request its removal.Impact
Unsolicited short flags increase the CLI surface area, can conflict with future flags, and do not match user intent. Only add abbreviated forms when explicitly asked to do so.