Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the short option -o for --overwrite #1483

Merged
merged 3 commits into from
Jul 24, 2024
Merged

Conversation

leighmcculloch
Copy link
Member

What

Remove the short option -o for --overwrite.

Why

The --overwrite option is destructive and users can lose files and hard work by using it. We should make it very explicit and obvious when users are doing things that could cause them to lose work.

A second reason is that we should reserve short options for the most common workflows, and the workflows where someone can look at the short command in context and almost be able to guess as to what that short option means or at least the cognitive load of remembering what it means should be matched with the value the user gets out of having to remember. The overwrite workflow is unlikely to be used by many people, and on something like a init command the -o option is pretty ambiguous.

@leighmcculloch leighmcculloch marked this pull request as ready for review July 23, 2024 21:33
@willemneal willemneal enabled auto-merge (squash) July 24, 2024 13:01
@willemneal willemneal merged commit c2b6d2f into main Jul 24, 2024
24 checks passed
@willemneal willemneal deleted the digestant-crinoidean branch July 24, 2024 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants