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

multiple_values() documentation wrong #1828

Closed
intgr opened this issue Apr 15, 2020 · 3 comments · Fixed by #2538
Closed

multiple_values() documentation wrong #1828

intgr opened this issue Apr 15, 2020 · 3 comments · Fixed by #2538
Labels
A-docs Area: documentation, including docs.rs, readme, examples, etc...
Milestone

Comments

@intgr
Copy link
Contributor

intgr commented Apr 15, 2020

Clap version

master branch (d210b9f)

Where

https://github.com/clap-rs/clap/blob/master/src/build/arg/mod.rs#L3729-L3777

What's wrong

The Arg::multiple_values() method doc talks about empty values instead (?!) is this a copy-paste error?

/// Allows an argument to accept explicitly empty values. An empty value must be specified at
/// the command line with an explicit `""`, `''`, or `--option=`

PS: I also find the distinction between MultipleValues and MultipleOccurrences very confusing and not well documented, I don't understand enough to do it myself.

@intgr intgr added the A-docs Area: documentation, including docs.rs, readme, examples, etc... label Apr 15, 2020
@pksunkara pksunkara added this to the 3.0 milestone Apr 15, 2020
@pksunkara
Copy link
Member

There's another issue for that #1026

@kbknapp
Copy link
Member

kbknapp commented Apr 29, 2020

I've started a branch (v3-docs) where I'm trying to go through and finally knock out some of these docs issues and update all the examples and such.

@pksunkara
Copy link
Member

@kbknapp Thanks. Just wanted to let you know that I am working on updating the README.

@intgr intgr changed the title multiple_values() documentation flat out wrong multiple_values() documentation wrong Jul 18, 2020
@ldm0 ldm0 self-assigned this Mar 13, 2021
@pksunkara pksunkara linked a pull request Jun 16, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation, including docs.rs, readme, examples, etc...
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants