JuliaDocs/Documenter.jl

Executing jldoctest blocks out of process

Open

#893 geöffnet am 27. Nov. 2018

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Julia (513 Forks)batch import
Status: SpeculativeType: Featurehelp wanted

Repository-Metriken

Stars
 (910 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuche, wie Documenter derzeit jldoctest Blöcke ausführt. Prüfe die Möglichkeit, einen separaten Julia Prozess über `Base.run` zu starten, seine Standardausgabe zu erfassen und als alternative Ausführungsmethode zu integrieren. Überprüfe die vorhandene Testinfrastruktur und suche nach ähnlichen Prozessstartmustern im Code.
Tech Stack
julia
Domain
documentationtooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Julia
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45