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: main package symbols aren't documented: "There is no documentation for this package" #65731

Closed
tylerbrandt opened this issue Feb 15, 2024 · 1 comment
Labels
Milestone

Comments

@tylerbrandt
Copy link

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/tylerbrandt/godoc-example@v0.0.0-20240215181740-7b2d44c96bd8/app

What is your user agent?

Tested on Safari (Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.3 Safari/605.1.15) and Chrome

Screenshot

Screenshot 2024-02-15 at 11 40 30 AM

What did you do?

See linked repo which includes:

  • an app/main.go file (package main) including a documented function SayHello
  • an app/goodbye.go file (package main) including a documented function SayGoodbye
  • a lib/hello/hello.go file (package hello) that includes a documented function SayHello

What did you see happen?

SayHello function in package hello has generated docs (link); SayHello and SayGoodbye functions in package main are not ("There is no documentation for this package"; link).

What did you expect to see?

All 3 documented functions have generated docs. I didn't see any particular behavior of pkgsite which is documented as being different for the main package.

@gopherbot gopherbot added this to the Unreleased milestone Feb 15, 2024
@seankhliao
Copy link
Member

main packages aren't importable, so there's nothing exported, so nothing to document.

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

No branches or pull requests

3 participants