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.

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

wiki: CodeReviewComments change #28468

Closed
cn007b opened this issue Oct 29, 2018 · 5 comments
Closed

wiki: CodeReviewComments change #28468

cn007b opened this issue Oct 29, 2018 · 5 comments
Labels
FrozenDueToAge WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided.

Comments

@cn007b
Copy link
Contributor

cn007b commented Oct 29, 2018

Is it possible to add disclaimer or label or something like this
which will help figure out is this page related only to go core repository
or it's related to go code all over the world and it's list of go best practices.

Prerequisites:
I'd used this page as reference in my answer on stackoverflow but after some time I've found next comment to my answer:

the document is actually a set of rules to write "core" Go code
@katiehockman
Copy link
Contributor

@cn007b Could you clarify a bit more about what you are suggesting for this? What part of the documentation is unclear, and what do you expect for it to say instead?

It looks like you link to http://go/gh/golang/go/wiki/CodeReviewComments#receiver-names in your Stackoverflow answer, is that the wiki page you are referring to in this issue?

@katiehockman katiehockman added the WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided. label Oct 29, 2018
@dgryski
Copy link
Contributor

dgryski commented Oct 29, 2018

Most people use the Code Review Comments as guidelines for all Go code, not only the Go compiler and standard library. I don't think it needs a comment explaining this.

@cn007b
Copy link
Contributor Author

cn007b commented Oct 29, 2018 •
edited

Maybe it make sense just add one more additional line into description in top of this page which says:

guidelines for all Go code, not only the Go compiler and standard library

or something like this...

@agnivade
Copy link
Contributor

The page says -

This page collects common comments made during reviews of Go code, so that a single detailed explanation can be referred to by shorthands.

"Go code" is all Go code. If it was just for the compiler or standard library, it would have been explicitly mentioned. I don't see any ambiguity here.

@agnivade agnivade added WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided. and removed WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided. labels Oct 31, 2018
@bcmills
Copy link
Contributor

bcmills commented Nov 16, 2018

As noted, the guidelines are intended to be widely applicable. A disclaimer would not be appropriate.

@bcmills bcmills closed this as completed Nov 16, 2018
@golang golang locked and limited conversation to collaborators Nov 16, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@dgryski @agnivade @cn007b @bcmills @gopherbot @katiehockman