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

[A-docs] Numbers of methods of arg and app building in FAQ.md are wrong. #3148

Closed
2 tasks
vi opened this issue Dec 10, 2021 · 0 comments · Fixed by #3149
Closed
2 tasks

[A-docs] Numbers of methods of arg and app building in FAQ.md are wrong. #3148

vi opened this issue Dec 10, 2021 · 0 comments · Fixed by #3149
Labels
A-docs Area: documentation, including docs.rs, readme, examples, etc... C-bug Category: Updating dependencies

Comments

@vi
Copy link
Contributor

vi commented Dec 10, 2021

Please complete the following tasks

  • I have searched the discussions
  • I have searched the existing issues

Rust Version

Not applicable

Clap Version

v3.0.0-rc.4

Minimal reproducible code

Not applicable

Steps to reproduce the bug with the above code

Look at https://github.com/clap-rs/clap/blob/v3.0.0-rc.4/docs/FAQ.md, linked from README:

To build an App there are three [?]:

  • Derive Macros
  • Builder Pattern

To build an Arg there are four [?]:

  • Derive Macros
  • Builder Pattern

Actual Behaviour

FAQ.md's app and arg creation lists' introductory phrases are contradictory, probably leftover from Clap v2.

Expected Behaviour

FAQ does not contain phrases that are not play well with actual content in it.

Additional Context

No response

Debug Output

No response

@vi vi added the C-bug Category: Updating dependencies label Dec 10, 2021
@vi vi changed the title Numbers of methods of arg and app building in FAQ.md are wrong. [A-docs] Numbers of methods of arg and app building in FAQ.md are wrong. Dec 10, 2021
@epage epage added the A-docs Area: documentation, including docs.rs, readme, examples, etc... label Jan 11, 2022
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... C-bug Category: Updating dependencies
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants