Update checker - use a single option instead of two

refactor(cli): update checker - use a single option instead of two (#16372)
Update checker - use a single option instead of tworefactorupdate checker use single option instead

Committed by dsherret

commit message
refactor(cli): update checker - use a single option instead of two (#16372)

Editor assessment

The refactor type is appropriate for consolidating two options into one, and the length is fine. My complaint is the subject's construction: 'update checker - use a single option instead of two' relies on a dash and can be momentarily misread as the verb 'update' acting on a 'checker'. Punctuation-free phrasing such as 'update checker: replace two options with one' would read cleaner, and the spec's imperative examples avoid such compound constructions. There's no body either, so the motivation (API simplification? deprecation?) and whether the old options remain supported — a potentially breaking CLI question — go unstated. Serviceable, but under-explained.

Browse categories

More refactor examples · Back to search