JuliaDocs/Documenter.jl

Executing jldoctest blocks out of process

Open

#893 opened on Nov 27, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Julia (513 forks)batch import
Status: SpeculativeType: Featurehelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 30d)

Description

It will be nice to have an option to execute jldoctest blocks in an external, spawned process. This would be an alternate option to wrapping the code block in a module before execution. Will help in addressing issues like https://github.com/JuliaLang/Distributed.jl/issues/19 . stdout of the spawned process can be used to check for correctness.

Contributor guide

Research direction
Explore how Documenter currently executes jldoctest blocks. Look into the possibility of spawning a separate Julia process via `Base.run`, capturing its stdout, and integrating that as an alternative execution mode. Check the existing test infrastructure and see if there are similar patterns for process spawning elsewhere in the codebase.
Tech stack
julia
Domain
documentationtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45