Skip to content

Commit

Permalink
Doc new exemption features
Browse files Browse the repository at this point in the history
  • Loading branch information
fabio-looker committed Aug 5, 2024
1 parent 901a83d commit 8840624
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,18 +58,16 @@ In addition to linting against its [style guide](https://looker-open-source.gith

### Rule Exemptions

You can opt-out of rules granularly by locally specifying `rule_exemptions`.
You can opt-out of rules granularly by locally specifying rule exemptions.

The rule exemption syntax encourages developers to document the reason for each such exemption:
The rule exemption syntax encourages developers (optionally) to document the reason for each such exemption:

```lkml
view: rollup {
sql_table_name: my_table ;;

#LAMS
#rule_exemptions: {
# K3: "2018-11-12 - Bob said it's ok"
#}
#LAMS exempt: K3 {why: "Bob said it's ok"}

dimension: info {...}
...
```
Expand Down
5 changes: 5 additions & 0 deletions docs/release-notes/v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,8 @@ Patches:

- Enhance the manifest argument to accept paths to lkml, json, or yaml (with js-yaml)
- Add manifest-defaults argument

# v3.4

- Add rule `allow_exemptions` argument for rules to specify if they do not want to allow exemptions
- Add support for more compact exemption syntax. The older `rule_exemptions: {rule: "reason"}` syntax is still supported, though no longer emphasized

0 comments on commit 8840624

Please sign in to comment.