Skip to content

Commit 180c255

Browse files
committed
fixed python sdk docs
1 parent d2b7d7b commit 180c255

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

docs/python-sdk/api-reference/overview.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,17 @@ with elementary_test_context(asset=asset) as ctx:
5858
client.send_to_cloud(ctx)
5959
```
6060

61+
### `raise_on_error`
62+
63+
By default, `elementary_test_context` uses `raise_on_error=False`. This means that if a decorated test (or something inside the context) raises an exception, the SDK **captures it and records an `ERROR` execution** so you can still send results to Elementary Cloud without crashing your pipeline.
64+
65+
If you prefer **fail-fast** behavior (for example in CI), pass `raise_on_error=True` to re-raise exceptions after they are recorded:
66+
67+
```python
68+
with elementary_test_context(asset=asset, raise_on_error=True) as ctx:
69+
run_my_tests(df)
70+
```
71+
6172
## Test Decorators
6273

6374
The SDK provides decorators to define tests:

0 commit comments

Comments
 (0)