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: sort package list into stdlib and GOPATH #3305
Comments
As a new user of the language, starting to build up my own little library packages as I build more complicated programs, and starting to look at packages written by third parties, I definitely would like a way for godoc to show somewhat more clearly which packages are "core" libraries and which are third party. Being able to have the list-of-packages stay as a sidebar when viewing the individual package godoc pages would also be a win -- at least as somebody new to the language and libraries I find myself surfing around between the list of all packages and individual packages a lot, as I figure out what's where. |
Issue #5784 has been merged into this issue. |
issue #5571 is related to this issue and may be solved with a unified solution. For instance it would be possible to include three sections in the package listing, namely: * Standard repositories * Sub-repositories * Third party repositories |
Sorry I meant issue #5561. |
If you have many non-standard packages installed, it gets unwieldy to navigate. I would like standard packages and each part of GOPATH to have its own section, and also be able to collapse/expand each level. This idea: http://pkleiweg.home.xs4all.nl/go/godoc-demo.html |
@adg I'd like to add a practical observation. I find the headings misleading. Currently, (go1.4.2), $GOPATH imports are alphabetically intermingled with packages from the standard library under a heading "Standard library". Further down the page there is a heading "Other packages" where I'd naturally expect my imports to be listed. It's not a clear structure. I feel that separating Standard Library documentation from GOPATH would make more sense, but even if it's deemed not, the headings need to reflect the structure more accurately. |
@paulswanson I agree that the gopath packages should be in a separate list to the standard library. |
@adg, the more I use godoc the more it's ticking me off. What's required to move this forward? Is this one a question of consensus and / or implementation? Cheers. |
It's an implementation thing. |
It would be nice to have this worked on. A separation of Standard Library and GOPATH libraries would improve the Also, Merry Christmas and thank you for working on Go. |
I will take a stab at it. I also like @pebbe's suggestion about collapsing/expanding items beyond a certain depth. Makes for a much cleaner UI. |
When GOPATH has multiple parts, I would like to see each part have its own section |
Hmm .. that is a bit non-trivial as it would involve more changes to the I think the current CL is a good start, and since the original issue was just about grouping it into GOROOT and GOPATH, its good to keep this to just that to avoid further complexity in the review. Maybe it's best to tackle this in a separate issue. |
Change https://golang.org/cl/95835 mentions this issue: |
Change https://golang.org/cl/101295 mentions this issue: |
Separate the templates of package root directory and other directories. This removes several if-else conditions and makes the template code much cleaner. To be merged after CL 95835. For golang/go#3305 Change-Id: I435441dbe214e4c89271483173df7c30a42ee28f Reviewed-on: https://go-review.googlesource.com/101295 Run-TryBot: Andrew Bonventre <andybons@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Andrew Bonventre <andybons@golang.org>
The text was updated successfully, but these errors were encountered: