JuliaDocs/Documenter.jl

Easier doctests of non-exported functions

Open

#2,126 opened on May 21, 2023

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Julia (513 forks)batch import
Topic: UsabilityType: Enhancementhelp wanted

Repository metrics

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

Description

Hello,

I've recently started adding more doctests to unexported functions in my code, and I seem to be repeating the same boilerplate-y setup quite a bit, e.g.

"""
    parsechecksum(checksum::String)
    
...text...

```jldoctest; setup = :(import DataToolkitCommon.Store.parsechecksum)
julia> parsechecksum("crc32c:9c0188ee")
(:crc32c, 0x9c0188ee)
```
"""

Is there some way this boilerplate could be avoided?

Contributor guide

Research direction
Investigate how to automatically import non exported functions in doctests or provide a simpler syntax to avoid repetitive `setup` boilerplate.
Tech stack
None
Domain
documentationdeveloper experience
Issue type
Feature
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.
1-3 hours
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
JuliaDocumenter.jl
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70