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/doc: behaviour of "go doc" in module mode is not documented #61032

Open
dolmen opened this issue Jun 27, 2023 · 1 comment
Open

cmd/go/doc: behaviour of "go doc" in module mode is not documented #61032

dolmen opened this issue Jun 27, 2023 · 1 comment
Labels
Documentation GoCommand cmd/go NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone

Comments

@dolmen
Copy link
Contributor

dolmen commented Jun 27, 2023

The documentation for go doc still refers to GOPATH mode. No mention of Go module mode (which is now the default behavior).

What version of Go are you using (go version)?

$ go version
master

Does this issue reproduce with the latest release?

Yes (1.21rc2).
See https://pkg.go.dev/cmd/go@master#hdr-Show_documentation_for_package_or_symbol

What operating system and processor architecture are you using (go env)?

go env Output
$ go env
1.21rc2

What did you do?

$ go help doc

Or online: https://pkg.go.dev/cmd/go@master#hdr-Show_documentation_for_package_or_symbol

What did you expect to see?

Documentation of the "go doc" behavior in Go module mode, with no mention of GOPATH.

What did you see instead?

When run with one argument, the argument is treated as a Go-syntax-like
representation of the item to be documented. What the argument selects depends
on what is installed in GOROOT and GOPATH [...]

@cagedmantis cagedmantis added GoCommand cmd/go and removed GoCommand cmd/go labels Jun 28, 2023
@cagedmantis cagedmantis added this to the Backlog milestone Jun 29, 2023
@cagedmantis cagedmantis added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Jun 29, 2023
@cagedmantis
Copy link
Contributor

/cc @robpike @mvdan

@seankhliao seankhliao added the GoCommand cmd/go label Sep 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation GoCommand cmd/go NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Projects
None yet
Development

No branches or pull requests

4 participants