Go fmt Documentation

Review Request #11278 — Created Nov. 12, 2020 and submitted

jblazusi
ReviewBot
master
dc5bd43...
reviewbot, students
ceciliawei

This commit includes documentation for the gofmt Tool:
https://reviews.reviewboard.org/r/11265/

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

There should be a blank line after line 14.

ceciliaweiceciliawei

This sentence doesn't read right. I think the "however" should be the start of a new sentence, joined with the ...

chipx86chipx86

Should use the :file: role for .go. Also, "Go-formatted code ..."

chipx86chipx86

Since we're linking, let's not say where they can find it as something separate from the link. How about: See ...

chipx86chipx86
jblazusi
  1. 
      
  2. 
      
jblazusi
ceciliawei
  1. 
      
  2. docs/reviewbot/tools/gofmt.rst (Diff revision 2)
     
     

    There should be a blank line after line 14.

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

    This sentence doesn't read right. I think the "however" should be the start of a new sentence, joined with the "this tool ...".

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

    Should use the :file: role for .go.

    Also, "Go-formatted code ..."

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

    Since we're linking, let's not say where they can find it as something separate from the link. How about:

    See the official documentation on `installing Go`_.
    
  5. 
      
jblazusi
david
  1. Ship It!
  2. 
      
keanweng
  1. Ship It!
  2. 
      
ceciliawei
  1. Ship It!
  2. 
      
david
  1. Ship It!
  2. 
      
jblazusi
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-2.0.x (76e978d)
Loading...