Skip to content

Commit 3468325

Browse files
committed
docs: Describe the example we show
This also provides us another opportunity to link to the docs.
1 parent 5877f88 commit 3468325

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ pre-release-replacements = [
5151
{file="CHANGELOG.md", search="ReleaseDate", replace="{{date}}", min=1},
5252
{file="CHANGELOG.md", search="<!-- next-header -->", replace="<!-- next-header -->\n## [Unreleased] - ReleaseDate\n", exactly=1},
5353
{file="CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/clap-rs/clap/compare/{{tag_name}}...HEAD", exactly=1},
54-
{file="README.md", search="github.com/clap-rs/clap/blob/[^/]+/", replace="github.com/clap-rs/clap/blob/{{tag_name}}/", exactly=9, prerelease = true},
54+
{file="README.md", search="github.com/clap-rs/clap/blob/[^/]+/", replace="github.com/clap-rs/clap/blob/{{tag_name}}/", exactly=10, prerelease = true},
5555
{file="README.md", search="version = \"[a-z0-9\\.-]+\"", replace="version = \"{{version}}\"", exactly=1, prerelease = true},
5656
{file="src/derive.rs", search="github.com/clap-rs/clap/blob/[^/]+/", replace="github.com/clap-rs/clap/blob/{{tag_name}}/", exactly=4, prerelease = true},
5757
]

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ Create your command-line parser, with all of the bells and whistles, declarative
3131

3232
### Example
3333

34+
This uses our
35+
[Derive API](https://github.com/clap-rs/clap/blob/v3.0.10/examples/derive_ref/README.md)
36+
which provides access to the Builder API as attributes on a `struct`:
37+
3438
<!-- Copied from examples/demo.{rs,md} -->
3539
```rust,no_run
3640
use clap::Parser;

0 commit comments

Comments
 (0)