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: function does not appear in table of contents #38666

Closed
stamblerre opened this issue Apr 26, 2020 · 4 comments
Closed

x/pkgsite: function does not appear in table of contents #38666

stamblerre opened this issue Apr 26, 2020 · 4 comments

Comments

@stamblerre
Copy link
Contributor

@stamblerre stamblerre commented Apr 26, 2020

The function Expect appears on the page https://pkg.go.dev/github.com/onsi/gomega?tab=doc#Expect, but it is not listed in the table of contents.

@stamblerre stamblerre added the pkgsite label Apr 26, 2020
@go101
Copy link

@go101 go101 commented Apr 26, 2020

It is shown under "type Assertion", though I also feel this is some confused.

@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented May 1, 2020

/cc @dmitshur for input - this is also how it is currently displayed on godoc.org.

image

/cc @fflewddur @Joanne881107

@go101
Copy link

@go101 go101 commented May 7, 2020

This problem has been discussed before: #28006

@julieqiu julieqiu changed the title pkg.go.dev: function does not appear in table of contents x/pkgsite: function does not appear in table of contents Jun 15, 2020
@gopherbot gopherbot added this to the Unreleased milestone Jun 15, 2020
@dmitshur
Copy link
Member

@dmitshur dmitshur commented Jul 15, 2020

Per comments above, Expect is considered to be a "factory function" for Assertion, so it's displayed underneath it.

The code for this is in go/doc (see #39813 (comment)). I don't see anything to do here, so let's close this. We can use #39813 as the tracking issue for considering changes to the "factory function" behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants