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

x/mod/modfile: missing a package comment #36757

Closed
dmitshur opened this issue Jan 25, 2020 · 1 comment
Closed

x/mod/modfile: missing a package comment #36757

dmitshur opened this issue Jan 25, 2020 · 1 comment
Labels
Documentation FrozenDueToAge modules NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Backlog

Comments

@dmitshur
Copy link
Contributor

Per https://golang.org/doc/effective_go.html#commentary:

Every package should have a package comment, a block comment preceding the package clause.

Package modfile does not have one, as can be seen at https://pkg.go.dev/golang.org/x/mod. It should.

/cc @jayconrod @bcmills @matloob
@dmitshur dmitshur added Documentation NeedsFix The path to resolution is known, but the work has not been done. modules labels Jan 25, 2020
@dmitshur dmitshur added this to the Backlog milestone Jan 25, 2020
@jayconrod jayconrod self-assigned this Jan 27, 2020
@gopherbot
Copy link

Change https://golang.org/cl/216842 mentions this issue: modfile: add package documentation

@golang golang locked and limited conversation to collaborators Jan 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge modules NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
3 participants
@jayconrod @dmitshur @gopherbot