-
Notifications
You must be signed in to change notification settings - Fork 79
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
Use comments as field description #12
Conversation
Would love to see this reviewed and merged! We've used this great plugin, plus the code here to generate our BQ schema @ The New York Times. Our protobuf schema is used for generating lots of things in addition to the BQ schema, and so we store all of the field descriptions unobtrusively in comments. We would love to hear about any feedback/improvements as it seems pretty common thing to document .proto fields with comments. Thanks! |
@yugui Could you please give a review? |
Was just looking at writing some similar functionality -- any reason this hasn't gotten reviewed/merged? Other thoughts/approaches that are more sensible? @yugui , @chuhlomin ? What did you wind up using as a solution @sdotz ? |
It seems like this repo is not actively maintained. |
I’m using the @chuhlomin fork |
Awesome, thanks! |
It's a great addition, but please note that there appears to be an issue with comments in |
Konstantin -- we're looking to start maintaining this repo again. As you've forked it, do you have any interest in continuing to contribute? Thanks. |
I've tested out this change and am happy with it, but would like to update the examples to include descriptions. I'm merging it now and will add that on. |
This PR adds a fields description based on a comments in proto-files (unless they have a custom option
BigQueryFieldOptions.Description
defined).