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

Generate a clearer panic message #381

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

roshanavand
Copy link

This aims to fix this issue

@CLAassistant
Copy link

CLAassistant commented Jun 26, 2023

CLA assistant check
All committers have signed the CLA.

@marckhouzam
Copy link

@roshanavand would you mind specifying the output before this change and after this change?

@roshanavand
Copy link
Author

@marckhouzam Not at all.
Assuming we want to add a new flag named myFlag with shorthand h to a flagset named myFlagSet:
Before the message would read:
unable to redefine 'h' shorthand in "myFlagSet" flagset: it's already used for "myFlag" flag
Now it reads:
unable to define 'h' shorthand for "help" flag: it's already used for "myFlag" flag

Considering the linked issue, the custom flag is set first, after that the help flag creation is initiated and results to that panic.

@roshanavand
Copy link
Author

Especially in case of using h shorthand, the message is more vague for the user as they might not know that help with the same shorthand is being initiated later and causing that error.
But I believe the new message is clearer in all the situations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Misleading shorthand flag panic message
3 participants