Summary:

Cargo Tool Documentation

Review Request #11308 — Created Nov. 25, 2020 and submitted Jan. 18, 2021, 2:05 p.m.

Information
Owner:	jblazusi
Repository:	ReviewBot
Branch:	master
Bugs:
Depends On:
Commit:	6e01a2f...
Reviewers
Groups:	reviewbot, students
People:	ceciliawei

Description

This commit includes documentation for the Cargo Tool:
https://reviews.reviewboard.org/r/11307/

Testing Done

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.

Issues

Description	From	Last Updated
How about: See the official documentation on `installing Rust`_.	chipx86	Dec. 3, 2020, 6:15 p.m.
clippy should use the :program: role.	chipx86	Dec. 3, 2020, 6:15 p.m.
Let's move this inline :code: into its own a full code block, so it's not buried in the paragraph.	chipx86	Dec. 3, 2020, 6:25 p.m.
Missing a "to" after "in order"	keanweng	Dec. 4, 2020, 11:40 a.m.
This reads a little awkwardly. Perhaps "The Cargo tool..."? "Toolchain" here also probably doesn't need to be capitalized.	david	Dec. 6, 2020, 11:27 a.m.
Perhaps clarify that this is "Rust code"? Not all users may know what Cargo is.	david	Dec. 6, 2020, 11:27 a.m.

flake8 passed.

JSHint passed.

Change Summary:

Eliminated whitespace.

Commit:

-	5e0c1797818360738d737f2aaf3a19f7e90f553b
+	b192eed348d384cb2e94abf8dfc4b39fb2a88d8b

Diff:

Revision 2 (+38)

Show changes

	docs/reviewbot/tools/cargotool.rst
	docs/reviewbot/tools/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

docs/reviewbot/tools/cargotool.rst (Diff revision 2)

Show all issues

How about:

See the official documentation on `installing Rust`_.

docs/reviewbot/tools/cargotool.rst (Diff revision 2)
Show all issues
```
clippy should use the :program: role.
```

docs/reviewbot/tools/cargotool.rst (Diff revision 2)

Show all issues

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:

-	b192eed348d384cb2e94abf8dfc4b39fb2a88d8b
+	a3d02cdd0908086fbca790eae84286a3f0f7d592

Diff:

Revision 3 (+41)

Show changes

	docs/reviewbot/tools/cargotool.rst
	docs/reviewbot/tools/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Great documentation! It is clear and concise. I only found this little typo.

docs/reviewbot/tools/cargotool.rst (Diff revision 3)

Show all issues

Missing a "to" after "in order"

jblazusi Dec. 4, 2020, 11:40 a.m.

Thank you for taking the time to review my documentation and catching this mistake!

Other than the little NIT Kean found, everything looks great! The documentation makes sense to me.

jblazusi Dec. 4, 2020, 11:40 a.m.
```
Thank you Bruce!
```

Change Summary:

Fixed a small error in the writing

Commit:

-	a3d02cdd0908086fbca790eae84286a3f0f7d592
+	fbf013057888263653b8fecd492dd29c0de773ce

Diff:

Revision 4 (+41)

Show changes

	docs/reviewbot/tools/cargotool.rst
	docs/reviewbot/tools/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

docs/reviewbot/tools/cargotool.rst (Diff revision 4)

Show all issues

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)

Show all issues

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:

-	fbf013057888263653b8fecd492dd29c0de773ce
+	6e01a2f12f33e91e1c91ee98053a409b0778500d

Diff:

Revision 5 (+41)

Show changes

	docs/reviewbot/tools/cargotool.rst
	docs/reviewbot/tools/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-2.0.x (0b697b0)