You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Well I have no "vuepress" or Vue experience (or inclination =), so I'll make a mere feature suggestion instead of a PR:
One thing that can be really handy for the user/reader of generated Golang pkg docs (incl. all of std/*) is how every declaration being documented links to its source location in that pkg's repo. For example you read https://pkg.go.dev/[email protected]#Or and it links to https://cs.opensource.google/go/go/+/go1.22.4:src/cmp/cmp.go;l=63 (where one can then quickly skim the source for perhaps subtle details not being explicated in the doc texts, or look for a gotcha one ran into).
Well that might sound like a silly toyish "nice-to-have-but-not-gotta-have", except — main reason I suggest this here is actually for the many "Please document me!" occurrences remaining in the std reference pages 😁
Of course, it's nothing remotely critical or pressing — just posting it in case whoever's occasionally tinkering with the web/docs side of things might find it a curious convenience to hack into existence. Otherwise, might label it for a v1.0 or post-1.0 polishing phase; after all, I guess just for the sake of reference / docs lookup, many current Gerbil users are comfortable just keeping all of std readily at hand right in their editor..
The text was updated successfully, but these errors were encountered:
Additional discussion and resources: start with the IDE issue (#1226), follow the links, come join us in the Gerbil Core channel in gitter/matrix space.
Well I have no "vuepress" or Vue experience (or inclination =), so I'll make a mere feature suggestion instead of a PR:
One thing that can be really handy for the user/reader of generated Golang pkg docs (incl. all of std/*) is how every declaration being documented links to its source location in that pkg's repo. For example you read https://pkg.go.dev/[email protected]#Or and it links to https://cs.opensource.google/go/go/+/go1.22.4:src/cmp/cmp.go;l=63 (where one can then quickly skim the source for perhaps subtle details not being explicated in the doc texts, or look for a gotcha one ran into).
Well that might sound like a silly toyish "nice-to-have-but-not-gotta-have", except — main reason I suggest this here is actually for the many "Please document me!" occurrences remaining in the std reference pages 😁
Of course, it's nothing remotely critical or pressing — just posting it in case whoever's occasionally tinkering with the web/docs side of things might find it a curious convenience to hack into existence. Otherwise, might label it for a v1.0 or post-1.0 polishing phase; after all, I guess just for the sake of reference / docs lookup, many current Gerbil users are comfortable just keeping all of std readily at hand right in their editor..
The text was updated successfully, but these errors were encountered: