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

x/pkgsite: missing examples for https://pkg.go.dev/github.com/qqiao/pipeline@v1.0.0 #52363

Closed
qqiao opened this issue Apr 14, 2022 · 4 comments
Closed

Comments

@qqiao
Copy link

qqiao commented Apr 14, 2022

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/qqiao/pipeline@v1.0.0

What is your user agent?

'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.88 Safari/537.36'

Screenshot

N/A

What did you do?

Submitted the module to pkg.go.dev.

What did you expect to see?

pkg site should include a set of examples for various functions of the module since they are present in the *_test.go files as Example* functions. These examples also runs correctly by using go test -v ./....

Also, running godoc -http=:6060 generates a local version that correctly shows the examples.

What did you see instead?

No examples section.

@qqiao qqiao added the pkgsite label Apr 14, 2022
@gopherbot gopherbot added this to the pkgsite/unplanned milestone Apr 14, 2022
@qqiao qqiao changed the title x/pkgsite: x/pkgsite: missing examples for https://pkg.go.dev/github.com/qqiao/pipeline@v1.0.0 Apr 14, 2022
@ianlancetaylor
Copy link
Contributor

This may be related to generics. Perhaps the use of a generic type is causing the pkgsite code to fail to connect the example with the method.

@ianlancetaylor
Copy link
Contributor

CC @golang/pkgsite

@jba jba self-assigned this Apr 15, 2022
@jba
Copy link
Contributor

jba commented Apr 22, 2022

Ian is correct. See #52496.

I'm working on a fix for the standard library, which I'll then backport to pkgsite.

@gopherbot
Copy link

Change https://go.dev/cl/401621 mentions this issue: internal/godoc/internal/doc: support examples on generic methods

@rsc rsc unassigned jba Jun 22, 2022
@golang golang locked and limited conversation to collaborators Jun 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants