Technical previewShare feedback

Search

Search documentation

Per-block options

Updated Oct 31, 2026

The fence info string accepts these tokens after test:

OptionTypeEffect
name="..."stringUse the supplied test name instead of the nearest heading. Never auto-suffixed.
skipflagReport the test as skipped without running it.
onlyflagRun only the blocks marked only in this file; skip the rest.

The options follow livemark's fence-info convention: key="value" for parametric options, bare tokens for booleans. Values may be double- or single-quoted (\" escapes a quote), and words inside any attribute, such as title="the only example", are never read as options.

Naming a test explicitly

Useful when the heading is too generic or you want stable names regardless of heading edits.

```python test name="adds two positive numbers"
assert 1 + 1 == 2
```

User-supplied names are passed through verbatim — no #1/#2 suffixing even on collisions.

Skipping a test

Marks the block so pytest reports it as skipped (irondocs: skip) but doesn't execute it. Useful for documenting behavior that's pending or temporarily broken.

```python test skip
raise NotImplementedError
```

Focusing on one test

The pytest counterpart of vitest's it.only(...) — only the only blocks run in their file; the others are reported as skipped (irondocs: only).

```python test only
assert True
```

Combining options

Options can be combined freely. When both skip and only are set on the same block, skip wins (safer default for CI: no-op the marker rather than silently focus).

```python test only name="focus me"
assert True
```

Created with ❤ and Livemark