JuliaDocs/Documenter.jl

Easier doctests of non-exported functions

Offen

#2.126 geöffnet am 21.05.2023

 (9 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (513 Forks)batch import
Topic: UsabilityType: Enhancementhelp wanted

Repository-Metriken

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

Beschreibung

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