JuliaLang/julia

Use `jldoctest` wherever possible

Open

#56921 opened on Dec 30, 2024

View on GitHub
 (12 comments) (0 reactions) (0 assignees)Julia (48,709 stars) (5,773 forks)batch import
docsgood first issuehelp wanted

Description

jldoctest didn't used to support repl mode so we have a bunch of code blocks with julia-repl tags that should really be jldoctest instead.

Or, if you're feeling ambitious, it would be nice to audit all code blocks (grep for ```) and make as many as possible jldoctest.

Advice for folks implementing this

Contributor guide

Tech stack
None
Domain
documentationtesting
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Julia environment setupRead Documenter.jl doctest docsUnderstanding of Julia REPL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Identify current `julia repl` blocks by searching for triple backticks in documentation files. Replace them with `jldoctest` and update the output to match actual REPL sessions. Refer to the Documenter.jl doctest documentation. Start with a single block to ensure correctness. Check doctests pass using the provided instructions.