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.

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

feat: split doc.go generation into comments and code portions #1579

Merged
merged 6 commits into from
Nov 13, 2024

Conversation

shollyman
Copy link
Contributor

@shollyman shollyman commented Nov 4, 2024

This PR splits the current content of generated doc.go into their respective code and documentation generation parts.

  • doc.go - package docs, canonical import name
  • helpers.go - DefaultAuthScopes helper, client construction hook definitions, getVersionClient helper

Related: b/377347282

@shollyman shollyman marked this pull request as ready for review November 6, 2024 17:22
@shollyman shollyman requested review from a team as code owners November 6, 2024 17:22
@quartzmo
Copy link
Member

quartzmo commented Nov 6, 2024

@shollyman Bikeshed: Was there anything wrong with the simpler helpers.go name?

@shollyman
Copy link
Contributor Author

@shollyman Bikeshed: Was there anything wrong with the simpler helpers.go name?

Collision avoidance. Looking internally there's already a number of protos named helpers.proto so I wanted to avoid having to add special collision logic.

@shollyman
Copy link
Contributor Author

@shollyman Bikeshed: Was there anything wrong with the simpler helpers.go name?

Collision avoidance. Looking internally there's already a number of protos named helpers.proto so I wanted to avoid having to add special collision logic.

Though in retrospect, the protoc generator produces files with the .pb.go suffix so the risk of collision is smaller. I'm happy to switch back to helpers.go in that case.

@shollyman shollyman merged commit 396b171 into googleapis:main Nov 13, 2024
7 checks passed
@shollyman shollyman deleted the doc-split branch November 13, 2024 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants