Skip to content

Commit 9c2f56a

Browse files
authored
Update README (#34)
1 parent b000a9a commit 9c2f56a

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,15 @@ loading test data. Each loader takes two positional arguments:
4848
test file's directory toward the Pytest root directory to find the nearest data directory containing the
4949
target file.
5050

51-
Additionally, each loader supports different optional keyword arguments to customize how the data is loaded. See
52-
[Loader Options](#loader-options) section for details.
51+
> [!TIP]
52+
> - By default, the plugin looks for a directory named `data` when resolving relative paths. This default name can be
53+
> customized using an INI option. See the [INI Options](#ini-options) section for details
54+
> - Each data loader supports different optional keyword arguments to customize how the data is loaded. See the
55+
> [Loader Options](#loader-options) section for details
5356
5457

5558

56-
## Examples:
59+
## Examples
5760

5861
Given you have the following project structure:
5962
```
@@ -72,7 +75,6 @@ Given you have the following project structure:
7275
│ └── test_something_else.py
7376
└── test_something.py
7477
```
75-
The plugin searches for a data directory (default name: `data`) that contains the specified file or directory.
7678

7779
### 1. Load file data — `@load`
7880
`@load` is a file loader that loads the file content and passes it to the test function.

0 commit comments

Comments
 (0)