Skip to content

Commit 009d232

Browse files
committed
Rename example crate in README example
This is to avoid accidentally bumping its version when making new releases of version-sync.
1 parent 9b6ee82 commit 009d232

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,11 @@ test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured
4949
```
5050

5151
If the README or `html_root_url` is out of sync with the crate
52-
version, the tests fail. In this example, the version number in
53-
`Cargo.toml` has been changed to 0.2.0 while the `README.md` and
54-
`html_root_url` remain unchanged. The tests now fail and the
55-
problematic TOML code and attribute are shown:
52+
version, the tests fail. In this example, the crate is called
53+
`your-crate` and the version number in `Cargo.toml` has been changed
54+
to 0.2.0 while the `README.md` and `html_root_url` still use 0.1.2.
55+
The tests now fail and the problematic TOML code and attribute are
56+
shown:
5657

5758
```
5859
$ cargo test
@@ -69,15 +70,15 @@ failures:
6970
Checking code blocks in README.md...
7071
README.md (line 20) ... expected minor version 2, found 1 in
7172
[dev-dependencies]
72-
version-sync = "0.1"
73+
your-crate = "0.1"
7374
7475
thread 'test_readme_deps' panicked at 'dependency errors in README.md', tests/version-numbers.rs:6
7576
note: Run with `RUST_BACKTRACE=1` for a backtrace.
7677
7778
---- test_html_root_url stdout ----
7879
Checking doc attributes in src/lib.rs...
7980
src/lib.rs ... expected minor version 2, found 1 in
80-
#![doc(html_root_url = "https://docs.rs/version-sync/0.1.3")]
81+
#![doc(html_root_url = "https://docs.rs/your-crate/0.1.2")]
8182
8283
thread 'test_html_root_url' panicked at 'html_root_url errors in src/lib.rs', tests/version-numbers.rs:11
8384

0 commit comments

Comments
 (0)