Skip to content

Commit b4d3183

Browse files
committed
docs: remove combined PII + show_sample_rows scenario, simplify behavior matrix
1 parent 4372402 commit b4d3183

1 file changed

Lines changed: 18 additions & 30 deletions

File tree

docs/data-tests/test-result-samples.mdx

Lines changed: 18 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -186,46 +186,34 @@ models:
186186
tags: ['show_sample_rows']
187187
```
188188

189-
### Using both PII and `show_sample_rows` together
189+
## Behavior matrix
190190

191-
Both features can be enabled at the same time. **PII always takes precedence** -- if a model, column, or test has a PII tag, samples remain hidden even if `show_sample_rows` is also present.
191+
### `enable_samples_on_show_sample_rows_tags: true`
192192

193-
```yaml
194-
vars:
195-
disable_samples_on_pii_tags: true
196-
enable_samples_on_show_sample_rows_tags: true
197-
```
193+
| Level | Tags | Samples shown? |
194+
| --- | --- | --- |
195+
| model | none | No (hidden by default) |
196+
| model | `show_sample_rows` | Yes |
197+
| model | `pii` | No (hidden by default) |
198+
| test | `show_sample_rows` | Yes |
199+
| column | `show_sample_rows` | Yes |
198200

199-
## Behavior matrix
201+
### `disable_samples_on_pii_tags: true`
200202

201-
| `enable_samples_on_show_sample_rows_tags` | `disable_samples_on_pii_tags` | Level | Tags | Samples shown? |
202-
| --- | --- | --- | --- | --- |
203-
| `true` | `false` | model | none | No (hidden by default) |
204-
| `true` | `false` | model | `show_sample_rows` | Yes |
205-
| `true` | `false` | model | `pii` | No (hidden by default, PII feature not active) |
206-
| `true` | `false` | test | `show_sample_rows` | Yes |
207-
| `true` | `false` | column | `show_sample_rows` | Yes |
208-
| `true` | `true` | model | none | No (hidden by default) |
209-
| `true` | `true` | model | `show_sample_rows` | Yes |
210-
| `true` | `true` | model | `pii` | No (PII wins) |
211-
| `true` | `true` | model | `pii` + `show_sample_rows` | No (PII wins) |
212-
| `true` | `true` | test | `show_sample_rows` | Yes |
213-
| `true` | `true` | test | `pii` | No (PII wins) |
214-
| `true` | `true` | column | `show_sample_rows` (no pii) | Yes |
215-
| `true` | `true` | column | `pii` + `show_sample_rows` | No (PII wins) |
216-
| `false` | `true` | model | none | Yes |
217-
| `false` | `true` | model | `pii` | No |
218-
| `false` | `true` | test | `pii` | No |
219-
| `false` | `true` | column | `pii` | No |
220-
| `false` | `true` | column | `show_sample_rows` (no pii) | Yes (excluded from PII columns) |
221-
| `false` | `false` | any | any | Yes (both features off) |
203+
| Level | Tags | Samples shown? |
204+
| --- | --- | --- |
205+
| model | none | Yes |
206+
| model | `pii` | No |
207+
| test | `pii` | No |
208+
| column | `pii` | No |
209+
| column | `show_sample_rows` (no pii) | Yes (excluded from PII columns) |
222210

223211
## Configuration precedence
224212

225213
When multiple settings apply, Elementary follows this order (highest priority first):
226214

227215
1. **`disable_test_samples` in test meta** -- per-test on/off switch
228-
2. **`show_sample_rows` tag** -- when `enable_samples_on_show_sample_rows_tags: true` and the model, column, or test has a matching tag (unless overridden by PII)
216+
2. **`show_sample_rows` tag** -- when `enable_samples_on_show_sample_rows_tags: true` and the model, column, or test has a matching tag
229217
3. **`enable_samples_on_show_sample_rows_tags`** -- hides all samples by default when enabled
230218
4. **PII tag detection** -- when `disable_samples_on_pii_tags: true` and the model, column, or test has a matching tag
231219
5. **`test_sample_row_count` global var** -- project-wide sample size

0 commit comments

Comments
 (0)