-
Notifications
You must be signed in to change notification settings - Fork 19k
cmd/go: go tool and go get -tool could be documented better #77346
Copy link
Copy link
Closed as duplicate of#71663
Closed as duplicate of#71663
Copy link
Labels
DocumentationIssues describing a change to documentation.Issues describing a change to documentation.GoCommandcmd/gocmd/goNeedsInvestigationSomeone must examine and confirm this is a valid issue and not a duplicate of an existing one.Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.ToolProposalIssues describing a requested change to a Go tool or command-line program.Issues describing a requested change to a Go tool or command-line program.help wanted
Milestone
Metadata
Metadata
Assignees
Labels
DocumentationIssues describing a change to documentation.Issues describing a change to documentation.GoCommandcmd/gocmd/goNeedsInvestigationSomeone must examine and confirm this is a valid issue and not a duplicate of an existing one.Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.ToolProposalIssues describing a requested change to a Go tool or command-line program.Issues describing a requested change to a Go tool or command-line program.help wanted
I keep finding that experienced Go users are unaware of how great this new feature is. I find two sources of confusion in particular:
go get -toolexists; they instead editgo.modmanually, for example.go tool barworks as a short-hand forgo tool foo.com/full/package/path/bar.I suggest that we improve the UX here in three ways. First, make
go help toolpoint togo get -tooland vice versa, so that I can discover the existence of both commands by looking at the help of either.Second, tweak
go help toolso that this alias logic is actually documented. I assume it's based on the basename, but I'm not actually sure if the package name plays any part in it. It should also explain what happens with alias conflicts.Third, tweak
go toolwithout arguments so that it shows the available aliases, such as:cc @golang/tools-team