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

Jump to bottom

x/tools/godoc: golang.org/pkg not adding functions returning slices of T or *T to the display of type T #25005

Closed
rhcarvalho opened this issue Apr 23, 2018 · 5 comments
Closed

x/tools/godoc: golang.org/pkg not adding functions returning slices of T or *T to the display of type T #25005

rhcarvalho opened this issue Apr 23, 2018 · 5 comments
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Unreleased

Comments

@rhcarvalho
Copy link
Contributor

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

go version go1.10.1 darwin/amd64

Does this issue reproduce with the latest release?

Yes.

What did you do?

  1. Visit https://golang.org/pkg/net/mail/

image

  1. Run godoc -http :6060 and visit http://localhost:6060/pkg/net/mail/

image

  1. Visit https://godoc.org/net/mail

image

  1. Look at the output of go doc net/mail

  2. Look at the output of godoc net/mail (notice godoc x go doc)

What did you expect to see?

https://golang.org/pkg/net/mail/ should show func ParseAddressList(list string) ([]*Address, error) under type Address, just like the other ways of reading docs: local godoc -http, godoc.org, go doc and godoc.

The footer in https://golang.org/pkg/net/mail/ says "Build version go1.10.1.", and the Go 1.10 Release Notes document the new go doc behavior.

What did you see instead?

As the screenshot above shows, https://golang.org/pkg/net/mail/ has func ParseAddressList(list string) ([]*Address, error) detached from type Address in the Index listing, unlike all other ways of consuming documentation.
@gopherbot gopherbot added this to the Unreleased milestone Apr 23, 2018
@agnivade
Copy link
Contributor

Looks like this is working correctly at tip (https://tip.golang.org/pkg/net/mail/). But it should work in golang.org too. I checked out the 1.10 branch of tools repo and ran godoc locally and saw that the behavior is correct there.

@andybons - Can this be possibly related to an incorrect deployment of godoc that we were discussing here (https://go-review.googlesource.com/c/tools/+/103955#message-a8c77bae3e59094137aad91aa7fc4f7763ec7db5) ?

Tentatively marking as "NeedsInvestigation" but I think this should be "NeedsFix". Leaving it upto @andybons to check and confirm.

@agnivade agnivade added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Apr 23, 2018
@andybons andybons added the NeedsFix The path to resolution is known, but the work has not been done. label Apr 23, 2018
@gopherbot gopherbot removed the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Apr 23, 2018
@andybons
Copy link
Member

Yep this needs a fix.

@agnivade
Copy link
Contributor

@andybons - Can this be fixed as part of 1.11 release ? Looks like a simple deployment fix.

@andybons
Copy link
Member

Yes it will be fixed when 1.11 is released.

@agnivade
Copy link
Contributor

This is fixed now.

@golang golang locked and limited conversation to collaborators Jan 14, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
4 participants
@rhcarvalho @andybons @agnivade @gopherbot