Rust fmt Documentation

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

jblazusi
ReviewBot
master
d13e3de...
reviewbot, students
ceciliawei

This commit includes documentation for the rustfmt Tool:
https://reviews.reviewboard.org/r/11305/

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

When linking a single word, the backticks aren't necessary.

chipx86chipx86

You might want to consider rephrasing this. I think "however" should be a brand new sentence joined with the next ...

hailanhailan

The .rs part should use a :file: role: :file:`.rs` I'd also say "Rust-formatted code".

chipx86chipx86

Let's use the :program: role for rustfmt.

chipx86chipx86

Since we're linking, it doesn't seem necessary to say where the docs are found. Let's say: To learn more, see ...

chipx86chipx86
jblazusi
hailan
  1. 
      
  2. docs/reviewbot/tools/rustfmt.rst (Diff revision 2)
     
     
     

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

    1. Thank you very much for your input Hailan! I completely agree, I like your way of phrasing it much more.

  3. 
      
chipx86
  1. 
      
  2. docs/reviewbot/tools/rustfmt.rst (Diff revision 2)
     
     
     

    When linking a single word, the backticks aren't necessary.

  3. docs/reviewbot/tools/rustfmt.rst (Diff revision 2)
     
     

    The .rs part should use a :file: role:

    :file:`.rs`
    

    I'd also say "Rust-formatted code".

  4. docs/reviewbot/tools/rustfmt.rst (Diff revision 2)
     
     

    Let's use the :program: role for rustfmt.

  5. docs/reviewbot/tools/rustfmt.rst (Diff revision 2)
     
     
     
     

    Since we're linking, it doesn't seem necessary to say where the docs are found. Let's say:

    To learn more, see the documentation on `installing Rust`_ and `installing rustfmt`_.
    
  6. 
      
jblazusi
david
  1. Ship It!
  2. 
      
ceciliawei
  1. Ship It!
  2. 
      
jblazusi
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-2.0.x (ad578bc)
Loading...