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/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
Labels
FrozenDueToAge NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite UX Issues that involve UXD/UXR input
Milestone
Unreleased

Comments

@stamblerre
Copy link
Contributor

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.
@go101
Copy link

go101 commented Apr 26, 2020

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

@julieqiu
Copy link
Member

julieqiu commented May 1, 2020 •
edited

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

image

/cc @fflewddur @Joanne881107

@julieqiu julieqiu added NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. UX Issues that involve UXD/UXR input labels May 1, 2020
@go101
Copy link

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
@go101 go101 mentioned this issue Jun 26, 2020
Open
@go101 go101 mentioned this issue Jul 15, 2020
Open
@dmitshur
Copy link
Contributor

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.

@salewski salewski mentioned this issue Aug 20, 2020
Closed
@golang golang locked and limited conversation to collaborators Jul 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite UX Issues that involve UXD/UXR input
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
5 participants
@dmitshur @stamblerre @julieqiu @gopherbot @go101