golang/go
Voir sur GitHubx/pkgsite: exported variables should appear in the index and be anchored
Open
#42 855 ouverte le 27 nov. 2020
NeedsInvestigationhelp wantedpkgsitepkgsite/dochtml
Métriques du dépôt
- Stars
- (133 883 stars)
- Métriques de merge PR
- (Aucune PR mergée en 30 j)
Description
What is the URL of the page with the issue?
https://pkg.go.dev/github.com/frankban/quicktest@v1.11.2
What is your user agent?
Screenshot
See below
What did you do?
Related to https://github.com/golang/go/issues/42652
- Visited https://pkg.go.dev/github.com/frankban/quicktest@v1.11.2
- Tried to find the
IsNilvariable (which I had to know existed in the first place)
What did you expect to see?
I expected to be able to:
- quickly and discover all variables exported by this package
- quickly and easily find the
IsNilexported variable (in this case I knew it existed), read its documentation, and be able to link to its anchor for reference
What did you see instead?
- The variable not listed in the index
- No anchored heading for the variable
- The documentation buried in the documentation for the
Checkertype, with theIsNildocumentation seemingly being a continuation of theIsFalsevariable
To my mind there's a real discoverability problem here because IsNil and friends are exported precisely because they are intended to be used.