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

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

Open
jayconrod opened this issue Sep 16, 2020 · 0 comments
Open

Comments

@jayconrod
Copy link
Contributor

@jayconrod jayconrod commented Sep 16, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.