Cargo Tool Documentation
Review Request #11308 — Created Nov. 25, 2020 and submitted
This commit includes documentation for the Cargo Tool:
https://reviews.reviewboard.org/r/11307/
Manual testing was done using
make html
to verify that the .rst files
are being correctly generated into .html and that all links are
working.
Description | From | Last Updated |
---|---|---|
How about: See the official documentation on `installing Rust`_. |
chipx86 | |
clippy should use the :program: role. |
chipx86 | |
Let's move this inline :code: into its own a full code block, so it's not buried in the paragraph. |
chipx86 | |
Missing a "to" after "in order" |
keanweng | |
This reads a little awkwardly. Perhaps "The Cargo tool..."? "Toolchain" here also probably doesn't need to be capitalized. |
david | |
Perhaps clarify that this is "Rust code"? Not all users may know what Cargo is. |
david |
Change Summary:
Eliminated whitespace.
Commit: |
|
||||
---|---|---|---|---|---|
Diff: |
Revision 2 (+38) |
Checks run (2 succeeded)
-
-
docs/reviewbot/tools/cargotool.rst (Diff revision 2) How about:
See the official documentation on `installing Rust`_.
-
-
docs/reviewbot/tools/cargotool.rst (Diff revision 2) Let's move this inline
:code:
into its own a full code block, so it's not buried in the paragraph.
Change Summary:
Addressed Christian's feedback.
Commit: |
|
||||
---|---|---|---|---|---|
Diff: |
Revision 3 (+41) |
Checks run (2 succeeded)
Change Summary:
Fixed a small error in the writing
Commit: |
|
||||
---|---|---|---|---|---|
Diff: |
Revision 4 (+41) |
Checks run (2 succeeded)
-
-
docs/reviewbot/tools/cargotool.rst (Diff revision 4) This reads a little awkwardly. Perhaps "The Cargo tool..."?
"Toolchain" here also probably doesn't need to be capitalized.
-
docs/reviewbot/tools/cargotool.rst (Diff revision 4) Perhaps clarify that this is "Rust code"? Not all users may know what Cargo is.
Change Summary:
Addressed David's comments and updated documentation.
Commit: |
|
||||
---|---|---|---|---|---|
Diff: |
Revision 5 (+41) |