feat: generate type definition package godoc #142
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
product-auto-label
bot
added
the
api: eventarc
grayside
added
the
type: feature request
muncus
approved these changes
Jan 30, 2023
|
|
||
| // parseValueFromOptionString extracts the value associated with a particular | ||
| // field number from the Stringified options. | ||
| func parseValueFromOptions(o protoreflect.ProtoMessage, id string) string { |
There was a problem hiding this comment.
As discussed out-of-band, there's a tradeoff here that i think we can address better for cross-language docs by adding better docstrings in the original protos.
This parsing is a bit too clever for my liking, but it is a reasonable solution in the short term. 😅
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Extends the validation test generator to also generate type definition package godoc. This is meant to provide minimal documentation that helps the reader understand how the data type fits into the ecosystem, specifying the Google Cloud Product and the CloudEvent type that uses the data.