Summary

Go fmt Documentation

Review Request #11278 — Created Nov. 12, 2020 and submitted Jan. 4, 2021, 11:15 a.m.

Information

Owner

jblazusi

Repository

ReviewBot

Branch

master

Bugs

Depends On

Commit

dc5bd43...

Reviewers

Groups

reviewbot, students

People

ceciliawei

Description

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

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
There should be a blank line after line 14.	ceciliawei	Nov. 17, 2020, 5:28 p.m.
This sentence doesn't read right. I think the "however" should be the start of a new sentence, joined with the …	chipx86	Dec. 3, 2020, 2:12 p.m.
Should use the :file: role for .go. Also, "Go-formatted code ..."	chipx86	Dec. 3, 2020, 2:11 p.m.
Since we're linking, let's not say where they can find it as something separate from the link. How about: See …	chipx86	Dec. 3, 2020, 2:12 p.m.

flake8 passed.

JSHint passed.

Commit:

0e0aaf6e226330ed90ce38d527169ebf2651e182

8a336ee8c2613f7c873885b330c0e0cb3a602993

Diff:

Revision 2 (+20)

Show changes

	docs/reviewbot/tools/gofmt.rst
	docs/reviewbot/tools/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

docs/reviewbot/tools/gofmt.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
There should be a blank line after line 14.
```

Commit:

8a336ee8c2613f7c873885b330c0e0cb3a602993

14c5ab77008ffc6f90964288c2b0e66b9add78e6

Diff:

Revision 3 (+21)

Show changes

	docs/reviewbot/tools/gofmt.rst
	docs/reviewbot/tools/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

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

The issue has been resolved. Show all issues

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)
The issue has been resolved. Show all issues
```
Should use the :file: role for .go.
Also, "Go-formatted code ..."
```

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

The issue has been resolved. Show all issues

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:

14c5ab77008ffc6f90964288c2b0e66b9add78e6

dc5bd43d1c5617643b4ac10c21e0e8a8e675e857

People:

jace

Diff:

Revision 4 (+20)

Show changes

	docs/reviewbot/tools/gofmt.rst
	docs/reviewbot/tools/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-2.0.x (76e978d)