Skip to content

Commit 6a8f22a

Browse files
committed
docs(AGENTS): Clarify +SKIP is not permitted
why: +SKIP is just another workaround that doesn't test anything what: - Remove +SKIP from available tools - Explicitly state +SKIP is not permitted - Reference skip_if_binaries_missing for VCS availability
1 parent 12143ad commit 6a8f22a

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,9 +225,10 @@ type
225225
**Available tools for doctests:**
226226
- `doctest_namespace` fixtures: `tmp_path`, `asyncio`, `create_git_remote_repo`, `create_hg_remote_repo`, `create_svn_remote_repo`, `example_git_repo`
227227
- Ellipsis for variable output: `# doctest: +ELLIPSIS`
228-
- Skip for truly un-runnable examples: `# doctest: +SKIP` (use sparingly)
229228
- Update `pytest_plugin.py` to add new fixtures to `doctest_namespace`
230229

230+
**`# doctest: +SKIP` is NOT permitted** - it's just another workaround that doesn't test anything. If a VCS binary might not be installed, pytest already handles skipping via `skip_if_binaries_missing`. Use the fixtures properly.
231+
231232
**Async doctest pattern:**
232233
```python
233234
>>> async def example():

0 commit comments

Comments
 (0)