Doctests
Testing & QualitydoctestsDoctests is an Agent Skill for testing & quality published in the JuliaLang/julia repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Write and verify Julia `jldoctest` code blocks. Use whenever adding or changing a `jldoctest` block in a docstring (base/, stdlib/, Compiler/) or under doc/, and before opening a PR that touches doctests.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/JuliaLang/julia/blob/HEAD/doc/src/devdocs/agents/skills/doctests/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/doctests, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Julia doctests
Use this whenever you add or modify any jldoctest code block.
Writing
Before writing new doctests, review doc/src/devdocs/contributing/jldoctests.md
for best practices (filters, labels, setup code).
Verifying
If you changed any jldoctest block you MUST verify it. Follow these steps for
EVERY doctest change:
- Review
doc/src/devdocs/contributing/jldoctests.md. In particular, determine if any of the changed doctests require filters, labels or setup code. - Run the doctests to verify that your change works:
- To run doctest with the pre-built juliaup:
make -C doc doctest=true revise=true JULIA_EXECUTABLE=$HOME/.juliaup/bin/julia - To run doctest with in-tree julia (preferred):
make -C doc doctest=true revise=true. Do not pass any other options. - IMPORTANT: The doctests may take up to 15 minutes. Do NOT terminate the doctests before completion. Do NOT use a timeout for doctests.
- If you are ChatGPT, you may have to increase yield_timeout_ms.
- To run doctest with the pre-built juliaup: