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.

Sign up for GitHub

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: many public, documented functions missing from package docs #47253

Closed
Groxx opened this issue Jul 16, 2021 · 2 comments
Closed

x/pkgsite: many public, documented functions missing from package docs #47253

Groxx opened this issue Jul 16, 2021 · 2 comments
Labels
FrozenDueToAge pkgsite
Milestone
Unreleased

Comments

@Groxx
Copy link

Groxx commented Jul 16, 2021 •
edited

What is the URL of the page with the issue?

https://pkg.go.dev/go.uber.org/cadence@v0.17.0/workflow

What is your user agent?

~ latest chrome:
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36

Screenshot

Screen Shot 2021-07-16 at 13 34 54

What did you do?

Visit the URL, and look for e.g. workflow.ExecuteActivity docs: https://github.com/uber-go/cadence-client/blob/v0.17.0/workflow/workflow.go#L88

What did you expect to see?

All public funcs listed, with docs

What did you see instead?

Many funcs missing. Some from e.g. workflow.go are visible, like GetLogger, but others (both above and below that func) are not, and the same is true for other files in this package (e.g. context.go shows WithCancel in docs, but not WithValue).
@gopherbot gopherbot added this to the Unreleased milestone Jul 16, 2021
@Groxx
Copy link
Author

Groxx commented Jul 16, 2021

Actually, this is happening with the local code and go doc as well, and the list of funcs/types/etc seems identical at a glance. Strange.
At least poking locally is faster than checking the site.

@Groxx
Copy link
Author

Groxx commented Jul 16, 2021

No, nvm, they're grouped under e.g. type Future... though they're not methods of that type. They just return a value of that type.

TBH that seems extremely strange to me, as they're not conceptually "constructor funcs", but maybe it's not a new thing and I only just now noticed.

@Groxx Groxx closed this as completed Jul 16, 2021
@golang golang locked and limited conversation to collaborators Jul 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge pkgsite
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
2 participants
@Groxx @gopherbot