Add rule: public models should have an example SQL query in their description #30
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
| if model.language == "sql" and model.access == "public": | ||
| if "```sql" not in model.description: | ||
| return RuleViolation( | ||
| "The model description does not include an example SQL query." |
There was a problem hiding this comment.
I am not sure about this one, what if users only document their models with a oneliner? So not with a full markdown document that is rendered in the docs? Then does the rule still make sense?
There was a problem hiding this comment.
In that case no - but that would be the incentive of dbt-score, to encourage such a practice?
There was a problem hiding this comment.
Ok fair 👌 They can disable the rule if they really don't like it 😁
There was a problem hiding this comment.
Yes, definitely. It has a low severity, so it can always be kept as a reminder to write model documentation ;)
jochemvandooren
approved these changes
May 24, 2024
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.
No description provided.