Improve documentation on how to apply rule filters #93
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
docs/configuration.md
Outdated
| @@ -90,6 +90,18 @@ Every rule can be configured with the following option: | |||
| be found in the same namespace as the rules (see | |||
| [Package rules](package_rules.md)). | |||
|
|
|||
| Example: the generic rule `has_example_sql` shall apply only to frontend models. | |||
There was a problem hiding this comment.
Nice, good example! One thing I would like is that the example is part of the bullet point, because it's an addition to the rule_filter_names bulletpoint
matthieucan
reviewed
Jan 7, 2025
docs/configuration.md
Outdated
Comment on lines
98
to
103
| With `only_frontend_models` defined in `my_project_rules.py` as: | ||
| ```python | ||
| @rule_filter | ||
| def only_frontend_models(model: Model) -> bool: | ||
| -- condition which defines a frontend model | ||
| ``` |
There was a problem hiding this comment.
Instead of creating a new filter, maybe we could either:
- reference
only_schema_x, which doesn't exist per se but is an already fictional example from the documentation page on "Create rules". We could even link to it - reference the one that will soon exist in https://github.com/PicnicSupermarket/dbt-score/pull/90/files#diff-b67e959fc5f44264b902f469b41aa975dde46f9547c14c4f12871ccd1662d952
There was a problem hiding this comment.
Nice! I picked the second option.
matthieucan
reviewed
Jan 22, 2025
| @@ -90,6 +90,11 @@ Every rule can be configured with the following option: | |||
| be found in the same namespace as the rules (see | |||
| [Package rules](package_rules.md)). | |||
|
|
|||
| Example: the generic rule `has_example_sql` shall apply only to models materializing a table. | |||
There was a problem hiding this comment.
Suggested change
| Example: the generic rule `has_example_sql` shall apply only to models materializing a table. | |
| Example: the generic rule `has_example_sql` shall apply only to models materializing a table. | |
Newline before code block
Comment on lines
+94
to
+96
| ```toml | ||
| [tool.dbt-score.rules."dbt_score.rules.generic.has_example_sql"] | ||
| rule_filter_names=["rules.filters.is_table"] |
There was a problem hiding this comment.
Can you close the codeblock with triple-backticks?
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.
Fixes #92