Skip to content

Commit e8d94bd

Browse files
committed
fixed python sdk docs
1 parent 6dedb9f commit e8d94bd

1 file changed

Lines changed: 4 additions & 12 deletions

File tree

docs/python-sdk/api-reference/test-decorators.mdx

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,7 @@ def test_function(df: pd.DataFrame) -> float | list[float] | pd.Series:
100100
| `name` | str | Yes | - | Test name |
101101
| `min` | float | No | `None` | Minimum expected value (inclusive) |
102102
| `max` | float | No | `None` | Maximum expected value (inclusive) |
103-
| `severity` | str | No | `"ERROR"` | Test severity |
104-
| `description` | str | No | `None` | Test description |
105-
| `column_name` | str | No | `None` | Column being tested |
106-
| `tags`, `owners`, `metadata`, `quality_dimension`, `skip` | - | No | - | Same as `@boolean_test` |
103+
| `severity`, `description`, `column_name`, `tags`, `owners`, `metadata`, `quality_dimension`, `skip` | - | No | - | Same as `@boolean_test` |
107104

108105
### Example
109106

@@ -152,10 +149,7 @@ def test_function(df: pd.DataFrame) -> Any:
152149
| `name` | str | Yes | - | Test name |
153150
| `expected` | Any \| list[Any] | Yes | - | Expected value(s) - can be single value or list |
154151
| `allow_none` | bool | No | `False` | Whether to allow None values |
155-
| `severity` | str | No | `"ERROR"` | Test severity |
156-
| `description` | str | No | `None` | Test description |
157-
| `column_name` | str | No | `None` | Column being tested |
158-
| `tags`, `owners`, `metadata`, `quality_dimension`, `skip` | - | No | - | Same as `@boolean_test` |
152+
| `severity`, `description`, `column_name`, `tags`, `owners`, `metadata`, `quality_dimension`, `skip` | - | No | - | Same as `@boolean_test` |
159153

160154
### Example
161155

@@ -201,9 +195,7 @@ def test_function(df: pd.DataFrame) -> Sized:
201195
| `name` | str | Yes | - | Test name |
202196
| `min` | int | No | `None` | Minimum expected row count (inclusive) |
203197
| `max` | int | No | `None` | Maximum expected row count (inclusive) |
204-
| `severity` | str | No | `"ERROR"` | Test severity |
205-
| `description` | str | No | `None` | Test description |
206-
| `tags`, `owners`, `metadata`, `skip` | - | No | - | Same as `@boolean_test` |
198+
| `severity`, `description`, `tags`, `owners`, `metadata`, `skip` | - | No | - | Same as `@boolean_test` |
207199

208200
### Example
209201

@@ -216,7 +208,7 @@ def test_function(df: pd.DataFrame) -> Sized:
216208
description="Validate user count is within expected range",
217209
)
218210
def get_users_df(df: pd.DataFrame) -> pd.DataFrame:
219-
"""Return the dataframe - decorator calls len() on it."""
211+
"""Return the DataFrame; the decorator calls len() on it."""
220212
return df
221213
```
222214

0 commit comments

Comments
 (0)