Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cmd/go: typo in test.go doc #18572

Closed
gonutz opened this issue Jan 9, 2017 · 5 comments
Closed

cmd/go: typo in test.go doc #18572

gonutz opened this issue Jan 9, 2017 · 5 comments
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. Suggested Issues that may be good for new contributors looking for work to do.
Milestone
Go1.9

Comments

@gonutz
Copy link

gonutz commented Jan 9, 2017

In the doc string in src/cmd/go/test.go, line 65 it says: '...no arguments. It compiles...'.
There are two spaces before the 'It', should be only one.
@ALTree
Copy link
Member

ALTree commented Jan 9, 2017

See http://golang.org/cl/20022 for Brad's crusade against double space after period.

It only addressed // comments, and this one it's in a go string; we should decide if we want to fix docstrings too, and fix them all (there're others, for example at line 56 in the same src/cmd/go/test.go file), not just this occurrence.

cc @bradfitz

@ALTree ALTree added Documentation Issues describing a change to documentation. NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. labels Jan 9, 2017
@bradfitz
Copy link
Contributor

bradfitz commented Jan 9, 2017

It wasn't really a crusade, but rather an effort to make things mostly consistent once after we'd made a policy decision. Keeping things consistent will be a long-term (but easier) effort. Feel free to fix things as you see them.

@bradfitz bradfitz added NeedsFix The path to resolution is known, but the work has not been done. Suggested Issues that may be good for new contributors looking for work to do. and removed NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. labels Jan 9, 2017
@dsnet
Copy link
Member

dsnet commented Jan 9, 2017

As much as I support consistency, I am concerned that updating files here and there will muddle the code history. Perhaps we should just batch these types of cleanups to be only once in a while (e.g., start of every release cycle)?

@bradfitz
Copy link
Contributor

bradfitz commented Jan 9, 2017

Yes, I would prefer big CLs with many minor cleanups, but I'm not too worried about history. That's a tooling problem.

@bradfitz bradfitz added this to the Go1.9 milestone Jan 13, 2017
@bradfitz bradfitz changed the title cmd/go/test.go: typo in doc cmd/go: typo in test.go doc Jan 13, 2017
@gopherbot
Copy link
Contributor

CL https://golang.org/cl/45270 mentions this issue.

@golang golang locked and limited conversation to collaborators Jun 9, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. Suggested Issues that may be good for new contributors looking for work to do.
Projects
None yet
Milestone
Go1.9
Development

No branches or pull requests
5 participants
@bradfitz @ALTree @dsnet @gonutz @gopherbot