Skip to content

Commit b9c51eb

Browse files
committed
Refine pytest fixture docs wording
1 parent 6813bdb commit b9c51eb

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

docs/user-guide/test-data-generation.qmd

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -436,16 +436,16 @@ applying it to production data, or for creating reproducible test fixtures in yo
436436
## Pytest Fixture
437437

438438
When Pointblank is installed, a `generate_dataset` **pytest fixture** is automatically available
439-
in all your test files. There is no need to import anything or add configuration to `conftest.py`
440-
the fixture is registered via pytest's plugin system.
439+
in all your test files. There is no need to import anything or add configuration to `conftest.py`:
440+
the fixture is registered via pytest's plugin system.
441441

442442
The fixture works identically to `pb.generate_dataset()`, but with one key difference: when you
443443
don't supply a `seed=` parameter, a deterministic seed is automatically derived from the test's
444444
fully-qualified name. This means:
445445

446-
- The **same test** always produces the **same data** no manual seed management required.
447-
- **Different tests** get different seeds, so they exercise different datasets.
448-
- You can still pass an explicit `seed=` to override the automatic seed when needed.
446+
- the **same test** always produces the **same data**: no manual seed management required.
447+
- *different tests* get different seeds, so they exercise different datasets.
448+
- you can still pass an explicit `seed=` to override the automatic seed when needed.
449449

450450
### Basic Usage
451451

@@ -468,7 +468,7 @@ def test_etl_handles_nulls(generate_dataset):
468468
assert result.filter(pl.col("email").is_null()).shape[0] == 0
469469
```
470470

471-
All parameters from `generate_dataset()` are supported`n`, `seed`, `output`, and `country`:
471+
All parameters from `generate_dataset()` are supported: `n=`, `seed=`, `output=`, and `country=`:
472472

473473
```python
474474
def test_german_data(generate_dataset):
@@ -483,8 +483,7 @@ def test_german_data(generate_dataset):
483483

484484
### Multiple Datasets in One Test
485485

486-
Calling the fixture multiple times within the same test produces different (but still
487-
deterministic) data on each call:
486+
Calling the fixture multiple times within the same test produces different (but still deterministic) data on each call:
488487

489488
```python
490489
def test_merge_pipeline(generate_dataset):

0 commit comments

Comments
 (0)