JuliaPhysics / JuliaPhysics/Unitful.jl

Doctests are broken, should be run on CI

Open
#462 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Julia
Stars
675
Forks
124
Avg merge
3h 38m
Merged PRs (30d)
1

Description

E.g. in https://github.com/PainterQubits/Unitful.jl/blob/master/docs/src/conversion.md#unit-cancellation, there's a double `julia>` prompt, which breaks the test. Looks like doctests are not running on CI otherwise this probably would have been caught.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with docs/src/conversion.md at the unit-cancellation section and inspect how the project's documentation examples are currently processed. Check the existing CI configuration for any doctest step, then run the documentation tests locally. Done means the duplicated prompt is corrected and CI reliably executes the doctests so similar errors are caught.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
ci-cd, documentation, testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.