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

godoc: suggestion: the godoc.org page for package containing the go.mod file should also show an import path specified in the go.mod file #28720

Closed
go101 opened this issue Nov 11, 2018 · 3 comments

Comments

@go101
Copy link

@go101 go101 commented Nov 11, 2018

For example, this package https://godoc.org/github.com/go101/tinyrouter specified its import path in go.mod as go101.org/tinyrouter instead of its hosing path. Now the doc page only show an import path as the hosting path at the beginning of the path. I think it should also list the import path which is specified in go.mod.

@go101

This comment has been minimized.

Copy link
Author

@go101 go101 commented Nov 11, 2018

It would be better if the doc page can suggest a replace line for package users
if the godoc program finds that the hosting path and the module path specified
in the go.mod file are not consistent. For example:

Please add the following line in your go.mod file to use this package
if your project supports modules:

    replace go101.org/tinyrouter => github.com/go101/tinyrouter v1.0.1
@agnivade

This comment has been minimized.

Copy link
Contributor

@agnivade agnivade commented Nov 11, 2018

Hi, we have #26827 as the umbrella issue for tracking module support to godoc. Please add your comments there. Thank you.

@go101

This comment has been minimized.

Copy link
Author

@go101 go101 commented Nov 12, 2018

closed for #26827 (comment)

@go101 go101 closed this Nov 12, 2018
@golang golang locked and limited conversation to collaborators Nov 12, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
3 participants
You can’t perform that action at this time.