Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-14 14:52:33 +00:00
Code Issues Projects Releases Packages Wiki Activity
2556 commits 13 branches 549 tags 31 MiB
Commit graph

272 commits

Author SHA1 Message Date
Eric Mink
1c3958c56e Clarify documentation usage as help text for subcommands (#1620) 
* Clarify documentation usage as help text for subcommands

As outlined in https://github.com/clap-rs/clap/issues/1619 I did not understand why the `SUBCOMMANDS` section of `help` would not print a String `/// A subcommand for controlling testing` for the `Test` subcommand.

This PR updates the README to hopefully make this clearer.

The only change is adding a doc line:
```rust
#[derive(Clap)]
enum SubCommand {
    /// A help message for the Test subcommand
    Test(Test),
}
```

* Move annotation to the variant

Still regarding https://github.com/clap-rs/clap/issues/1619

I think the line that set the version of the subcommand was at the wrong place.
 2020-01-04 19:54:33 +05:30
Matthew Fisher
bb9631eb3f fix(README): fix compiler errors for first example (#1599) 
The first example doesn't compile. The Test structure is missing a `struct` statement, and the `.config` field exists as `.file`. Looking at the flag fields, `config` seems like the expected field name.

Using 

```
[dependencies]
clap = { git = "https://github.com/clap-rs/clap", features = ["wrap_help"] }
```

Signed-Off-By: Matthew Fisher <matt.fisher@microsoft.com>
 2019-11-30 00:35:26 +01:00
Kevin K
9d58bbee24
docs(README.md): fixes the custom derive example in the readme 
Closes #1589
 2019-10-30 20:30:29 -04:00
Kevin K
7f046f28ab
Merge pull request #1590 from clap-rs/msrv-1.36 
Msrv 1.36
 2019-10-30 18:30:44 -04:00
Kevin K
98e8cfe0c4
meta: Bump the minimum supported Rust to 1.36 2019-10-30 16:56:27 -04:00
Dylan DPC
5318342112
Update README.md 2019-10-30 10:28:37 +01:00
Kevin K
4fdca7b4e6
docs: corrects notes about v2 vs v3 branches 2019-10-29 22:30:17 -04:00
Kevin K
1cc872b369
Rename assert_cli to assert_cmd 2019-10-29 22:25:22 -04:00
Dylan DPC
655f4262dd
Add note for 3.0 release (#1503) 2019-10-29 22:24:52 -04:00
Daniel José Domingos Serrano
59c3233a45
Fix yaml docs 2019-10-29 21:49:00 -04:00
Sascha Grunert
b6ebdba2e1
Fix opts variable name in README.md 2019-10-29 21:45:47 -04:00
Yuki Okushi
e56b80b316
Fix license badge on README 2019-10-29 21:44:20 -04:00
Tshepang Lekhonkhobe
a720de3f24
typo 2019-10-29 21:44:01 -04:00
Erick Tryzelaar
d4cd4896dd Bump minimum supported version of Rust to 1.33 2019-06-19 11:21:11 -07:00
Kevin K
3f2a85ef15
Fix Travis CI badge 2019-04-04 13:24:24 -04:00
Kevin K
3550066c88 refactor: cleans out deprecated code in prep for final beta.1 push 2018-11-08 20:34:13 -05:00
Kevin K
03333800fe refactor: remove code going to other crates and deprecations 2018-10-19 23:31:06 -04:00
Kevin K
1ffc9556b7
docs(README.md): stars the v3 update of the docs 2018-08-01 23:05:52 -04:00
Kevin K
94872e00a5
refactor(Arg): changes Arg::short to accept a char instead of &str 
Closes #1303
 2018-07-23 15:10:12 -04:00
Kevin K
ab8c97e3f1
chore: relicense under MIT and APACHE 2.0 2018-07-23 14:25:18 -04:00
Dylan DPC
6a99e638f7 Fix assert_cli url 
Even though github redirects to the correct url, it is better to mention the correct one 😄
 2018-06-30 19:33:58 -04:00
Simon Egersand
30e6cd192a Fix formatting in README 2018-06-30 19:33:43 -04:00
Katharina
919fd32dfb
Moving the line into the apropriate section 2018-03-19 17:11:57 -04:00
Kevin K
e1d1c06d45
chore: updates version sync in readme 2018-02-09 23:40:55 -05:00
Kevin K
300a059f51
chore: updates the version tests 2018-02-03 15:22:56 -05:00
Kevin K
df996822c8 chore: increase version 2018-01-16 15:01:53 -05:00
Kevin K
3fef176543 docs: fixes typo in docs version 2018-01-09 12:07:19 -05:00
Kevin K
92caafaf51 chore: increase version 2018-01-09 11:08:47 -05:00
Romain Vimont
d954b3c734 Update default features in README 
Since commit ac97edde90, feature
"wrap_help" is not enabled by default.

Update the README accordingly.
 2017-12-05 13:55:57 +01:00
Kevin K
e962f2cece
chore: increase version 2017-12-02 15:34:02 -05:00
Kevin K
58a57d901b
chore: increase version 2017-11-28 08:57:04 -05:00
Kevin K
ce6ca492c7
docs: changes the demo version to 2.28 to stay in sync 2017-11-28 04:38:37 -05:00
Kevin K
9ef3d82bd0
chore: increase version 2017-11-27 10:28:28 -05:00
Kevin K
db6caf8663 docs(README.md): updates the readme and pulls out some redundant sections 2017-11-02 23:15:02 -04:00
Kevin K
67170a8bd7
chore: increase version 2017-10-26 10:09:48 -04:00
Kevin K
385596f6f6 chore: fix copy paste typo 2017-10-24 21:50:19 -04:00
Kevin K
3a471b72ce
docs: fixes some typo mistakes 2017-10-24 20:30:11 -04:00
Kevin K
e3eaf56b36
chore: increase version 2017-10-24 15:31:33 -07:00
Kevin K
3224e2e1cd Merge pull request #1051 from malbarbo/master 
make vec_map optional
 2017-10-03 21:49:01 -04:00
Marco A L Barbosa
d7a9f324b9 Add vec_map feature to README.md 2017-10-02 15:56:55 -03:00
Martin Geisler
e09c248fc1 tests: ensure README version numbers are in sync 2017-09-23 12:45:50 +02:00
Martin Geisler
5536361bcd docs: sync README version numbers with crate version 2017-09-23 12:32:49 +02:00
Kevin K
f093b4c1f8
chore: increase version 2017-09-14 10:39:24 -07:00
Kevin K
cbd813c1a0
chore: increase version 2017-09-13 20:55:00 -07:00
Manuel Reinhardt
9d089c1cc0 Fix small typo in Readme 2017-08-08 19:34:31 +02:00
Kevin K
517276c6f3
chore: increase version 2017-07-29 15:29:39 -04:00
Kevin K
76869a0d68 chore: fix increase version 2017-07-21 09:59:01 -04:00
Kevin K
00f8d28ab4 chore: increase version 2017-07-21 09:56:06 -04:00
Kevin K
e27a6ffbde chore: increase version 
* chore: disables mention-bots finding reviewers and pinging tons of people

* docs(README.md): added a warning about using ~ deps

* chore: increase version
 2017-06-19 22:57:54 -04:00
Kevin K
821929b51b docs(README.md): added a warning about using ~ deps 
Closes #964
 2017-05-29 13:10:55 -04:00