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

docs: Update mut_arg docs on help + version flags #4851

Merged
merged 1 commit into from
Apr 21, 2023
Merged

docs: Update mut_arg docs on help + version flags #4851

merged 1 commit into from
Apr 21, 2023

Conversation

ClementTsang
Copy link
Contributor

I was recently migrating from clap 3 to 4, and one of the things pointed out as a big change here was that mut_args no longer works for pre-defined help and version flags.

However, in docs.rs, for mut_arg, it still states:

This can be useful for modifying the auto-generated help or version arguments.

Which might be confusing, since if you try that, you'll get something like:

thread 'main' panicked at 'Argument `help` is undefined'

This just removes that line since IMO it'll just lead to confusion with the newer behaviour.

@ClementTsang ClementTsang changed the title doc: update outdated mut_arg documentation regarding help and version flags docs: update outdated mut_arg documentation regarding help and version flags Apr 21, 2023
@ClementTsang ClementTsang changed the title docs: update outdated mut_arg documentation regarding help and version flags docs: Update outdated mut_arg documentation about help and version flags Apr 21, 2023
@ClementTsang ClementTsang changed the title docs: Update outdated mut_arg documentation about help and version flags @ClementTsang docs: Update mut_arg docs on help + version flags Apr 21, 2023
@ClementTsang ClementTsang changed the title @ClementTsang docs: Update mut_arg docs on help + version flags docs: Update mut_arg docs on help + version flags Apr 21, 2023
@epage epage merged commit c38b8ca into clap-rs:master Apr 21, 2023
21 checks passed
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.

None yet

2 participants