Skip to content

cmd/go: revise 'go help' documentation for modules and module-aware commands #41427

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
Closed
jayconrod opened this issue Sep 16, 2020 · 1 comment
Closed

cmd/go: revise 'go help' documentation for modules and module-aware commands #41427

jayconrod opened this issue Sep 16, 2020 · 1 comment
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge modules NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Go1.16

Comments

@jayconrod
Copy link
Contributor

jayconrod commented Sep 16, 2020 •
edited
Loading

go help modules (and equivalently https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) is the original reference page for modules. It's fairly long for an introduction, but at the same time, it doesn't go into enough detail or provide enough examples to be a thorough reference.

https://golang.org/ref/mod is intended to replace go help modules as a detailed reference. In Go 1.16, we should change go help modules to point to that.

A few other help pages have this problem, in particular, go help module-get (https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them). The help page for each command should provide a brief synopsis of its arguments and flags, then should point to reference documentation like https://golang.org/ref/mod#go-get for more detail.

Related #33637.
@jayconrod jayconrod added Documentation Issues describing a change to documentation. NeedsFix The path to resolution is known, but the work has not been done. modules labels Sep 16, 2020
@jayconrod jayconrod added this to the Go1.16 milestone Sep 16, 2020
@jayconrod jayconrod mentioned this issue Sep 16, 2020
Closed
@bcmills bcmills mentioned this issue Nov 6, 2020
Closed
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/282615 mentions this issue: cmd/go: revise 'go help' documentation for modules

@golang golang locked and limited conversation to collaborators Jan 8, 2022
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 modules NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Go1.16
Development

No branches or pull requests
2 participants
@jayconrod @gopherbot