Help message for `mdbook test` is a bit misleading
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 88/100
Research direction
The change is to the one-line help text for the mdbook test subcommand, so search the Rust source for the existing string "Tests that a book's Rust code samples compile". Run mdbook test --help before and after editing to confirm the new wording appears in both mdbook --help and mdbook test --help. Done when the description says the samples are compiled and run, and the existing test suite still passes.
Written by the indexing model from the issue text.
Description
Problem
The help message for mdbook test says Tests that a book's Rust code samples compile, but it actually runs them as well.
Steps
mdbook --help or mdbook test --help
Possible Solution(s)
Change it to something that better reflects its behavior, such as Compiles and runs a book's Rust code samples.
Notes
Although this is a very small change, I'd love the opportunity to make it myself if this is something you want to go ahead with.
Version
mdbook v0.5.4
- Dominant language
- Rust
- Stars
- 22.2k
- Forks
- 1.9k
- Avg merge
- 4d 3h
- Merged PRs (30d)
- 4
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from rust-lang/mdBook
-
C-bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Search shortcut "/" is unreachable on Firefix and on keyboard layouts where "/" requires Shift (AZERTY, QWERTZ, etc.)Possibly taken @mmustafasenoglu claimed this 28 days ago. OpenC-enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
C-enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Update documentation to include `print.md` and `print.html`Possibly taken @ChrisJr404 claimed this 159 days ago. OpenC-enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
All issues in rust-lang/mdBook
Similar issues
-
build: Update rust versionPossibly taken A pull request linked to this issue is open or already merged. Opendependencies
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
ibm-granite-community/granite-cli#229 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
orottier/web-audio-api-rs#658 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
aosama/astronomical#1318 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
shep-pm/shep-kelpie#980 ·
Maintainers usually reply within 1 day