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.

Sign up for GitHub

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

Jump to bottom

gengapic: move top-level package docs link to more prominent position #1140

Closed
noahdietz opened this issue Sep 19, 2022 · 2 comments · Fixed by #1175, #1203 or googleapis/google-cloud-go#7225
Closed

gengapic: move top-level package docs link to more prominent position #1140

noahdietz opened this issue Sep 19, 2022 · 2 comments · Fixed by #1175, #1203 or googleapis/google-cloud-go#7225
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@noahdietz
Copy link
Collaborator

noahdietz commented Sep 19, 2022 •
edited
Loading

The top-level Go Client docs contain a lot of information that applies to most/all of the clients it contains: https://pkg.go.dev/cloud.google.com/go.

In GAPICs, the link to this documentation is kind of buried. It would be better if it had its own header or a more prominent position so that it is easier to find. Currently, it is the last thing in the package level documentation under a more specific header.

image
@noahdietz noahdietz added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. priority: p3 Desirable enhancement or fix. May not be included in next release. labels Sep 19, 2022
@noahdietz
Copy link
Collaborator Author

Let's use the new hyperlinked text godoc feature as well.

@quartzmo
Copy link
Member

https://tip.golang.org/doc/comment#links

@noahdietz noahdietz mentioned this issue Jan 3, 2023
Merged
gcf-merge-on-green bot pushed a commit that referenced this issue Jan 9, 2023
@adrianajg
fix(gengapic): move top-level package doc links to top (#1175)
8cf6194 
Fixes #1140
@release-please release-please bot mentioned this issue Jan 9, 2023
Merged
@noahdietz noahdietz mentioned this issue Jan 9, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Milestone
No milestone
2 participants
@quartzmo @noahdietz