chore: Allow additional description to be specified#2323
Closed
chore: Allow additional description to be specified#2323
Conversation
This allows us to add helpful hints like: ``` The aws_ec2_vpc_endpoint_services table shows data for Amazon Elastic Compute Cloud (EC2) VPC Endpoint Services. Note: You will usually want to use `WHERE owner != 'amazon'` when querying this table. ``` The second line is the additional description.
stoovon
changed the title
erezrokah
reviewed
Nov 7, 2025
Member
erezrokah
left a comment
erezrokah
left a comment
There was a problem hiding this comment.
Can't we use a multi-line description instead?
Member
|
See example https://github.com/cloudquery/cloudquery-private/blob/36b662a1dafe0aa6d6b09603863116313578477a/plugins/source/azure/resources/services/monitor/metrics.go#L18 where we embed a whole markdown file as a description |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This allows us to add helpful hints like:
The second line is the additional description.
Once this PR is merged, we'll need to modify the documentation generator to render the additional description.
Use the following steps to ensure your PR is ready to be reviewed
go fmtto format your code 🖊golangci-lint run🚨 (install golangci-lint here)