Go fmt Documentation
Review Request #11278 — Created Nov. 13, 2020 and submitted
Information | |
---|---|
jblazusi | |
ReviewBot | |
master | |
dc5bd43... | |
Reviewers | |
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. |
|
|
This sentence doesn't read right. I think the "however" should be the start of a new sentence, joined with the … |
|
|
Should use the :file: role for .go. Also, "Go-formatted code ..." |
|
|
Since we're linking, let's not say where they can find it as something separate from the link. How about: See … |
|

Commit: |
|
||||
---|---|---|---|---|---|
Diff: |
Revision 2 (+20) |
Checks run (2 succeeded)

Commit: |
|
||||
---|---|---|---|---|---|
Diff: |
Revision 3 (+21) |
Checks run (2 succeeded)
-
-
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 ...".
-
docs/reviewbot/tools/gofmt.rst (Diff revision 3) Should use the
:file:
role for.go
.Also, "Go-formatted code ..."
-
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`_.

Change Summary:
Corrected documentation based on Christian's feedback.
Commit: |
|
||||
---|---|---|---|---|---|
People: |
|
||||
Diff: |
Revision 4 (+20) |