Cargo Tool Documentation

Review Request #11308 — Created Nov. 25, 2020 and submitted

Information

ReviewBot
master
6e01a2f...

Reviewers

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`_.

chipx86chipx86

clippy should use the :program: role.

chipx86chipx86

Let's move this inline :code: into its own a full code block, so it's not buried in the paragraph.

chipx86chipx86

Missing a "to" after "in order"

keanwengkeanweng

This reads a little awkwardly. Perhaps "The Cargo tool..."? "Toolchain" here also probably doesn't need to be capitalized.

daviddavid

Perhaps clarify that this is "Rust code"? Not all users may know what Cargo is.

daviddavid
jblazusi
chipx86
  1. 
      
  2. docs/reviewbot/tools/cargotool.rst (Diff revision 2)
     
     
     

    How about:

    See the official documentation on `installing Rust`_.
    
  3. docs/reviewbot/tools/cargotool.rst (Diff revision 2)
     
     

    clippy should use the :program: role.

  4. 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.

  5. 
      
jblazusi
keanweng
  1. 
      
  2. Great documentation! It is clear and concise. I only found this little typo.

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

    Missing a "to" after "in order"

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

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

  3. 
      
jblazusi
david
  1. 
      
  2. 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.

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

    Perhaps clarify that this is "Rust code"? Not all users may know what Cargo is.

  4. 
      
jblazusi
ceciliawei
  1. Ship It!
  2. 
      
jblazusi
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-2.0.x (0b697b0)
Loading...