flake8
passed.
JSHint
passed.
Rust fmt Documentation
Review Request #11306 — Created Nov. 25, 2020 and submitted
This commit includes documentation for the rustfmt Tool:
https://reviews.reviewboard.org/r/11305/
Manual testing was done using
make htmlto verify that the .rst files
are being correctly generated into .html and that all links are
working.
| Description | From | Last Updated |
|---|---|---|
|
When linking a single word, the backticks aren't necessary. |
 chipx86
|
|
|
You might want to consider rephrasing this. I think "however" should be a brand new sentence joined with the next … |
 hailan
|
|
|
The .rs part should use a :file: role: :file:`.rs` I'd also say "Rust-formatted code". |
chipx86
|
|
|
Let's use the :program: role for rustfmt. |
chipx86
|
|
|
Since we're linking, it doesn't seem necessary to say where the docs are found. Let's say: To learn more, see … |
chipx86
|
- Change Summary:
-
Eliminated whitespace.
- Commit:
-
ffe9032871086bac0563e57950042543fe960bd40cd31965ec15528e867d48bfc1699c520b3c9e8c
Checks run (2 succeeded)
flake8
passed.
JSHint
passed.
-
-
You might want to consider rephrasing this. I think "however" should be a brand new sentence joined with the next sentence. Something like (warning: I'm not the best writer):
Although rustfmt formats code automatically, this tool will only be responsible for checking whether a .rs file is formatted correctly since the bot will not be changing any code...
