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/tools/cmd/godoc: show internal packages when explicitly requested #12092

Open
jacobsa opened this Issue Aug 10, 2015 · 2 comments

Comments

Projects
None yet
3 participants
@jacobsa
Contributor

jacobsa commented Aug 10, 2015

godoc's HTTP viewer by default appears to hide internal/ directories. For example, neither of these views give a hint that net/internal/socktest exists:

But sometimes it's nice to be able to look at the internals of a package that you're working on. (In particular, if there are a few internal packages, it's nice to see a list.) However, godoc continues to deny the existence of net/internal/ even when it's explicitly requested:

Instead you must already know exactly what you're looking for to be able to see it.

Can/should godoc be changed to show internal packages when an internal directory is explicitly requested, as in the /pkg/net/internal/ case above?

@adg

This comment has been minimized.

Contributor

adg commented Aug 10, 2015

You can see them with http://tip.golang.org/pkg/?m=all

I think it makes sense to hide these on golang.org, but probably not for most general godoc instances.

It was issue #8879 that had them removed.

@jacobsa

This comment has been minimized.

Contributor

jacobsa commented Aug 10, 2015

Thanks for the tip, that's great to know. It's not very discoverable though, so it would be nice if it were automatic when I've explicitly navigated to an internal/ directory. And yes, maybe good to make it the default outside of golang.org.

@rsc rsc added this to the Unplanned milestone Aug 10, 2015

@agnivade agnivade changed the title from cmd/godoc: show internal packages when explicitly requested to x/tools/cmd/godoc: show internal packages when explicitly requested Apr 25, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment