julia-doctests

What problem does it solve?

This skill helps developers write and verify executable examples within their Julia package documentation, ensuring that code snippets are accurate and functional.

Core Features & Use Cases

• Doctest Syntax: Supports both REPL-style and script-style doctest blocks.
• Setup & Teardown: Allows for defining setup code that runs before doctests and teardown code for cleanup.
• Handling Randomness: Provides guidance on using StableRNGs.jl for reproducible random number generation in tests.
• Filters: Enables the use of regular expressions to handle non-deterministic output and ensure test stability across environments.
• Use Case: When documenting a new function calculate_stats(data), you can include a doctest showing its usage and expected output, ensuring it remains correct as the package evolves.

Quick Start

Use the julia-doctests skill to add a doctest example to the double function in your package's documentation.