JuliaDocs/Documenter.jl

Easier doctests of non-exported functions

Open

#2126 aperta il 21 mag 2023

Vedi su GitHub
 (9 commenti) (0 reazioni) (0 assegnatari)Julia (513 fork)batch import
Topic: UsabilityType: Enhancementhelp wanted

Metriche repository

Star
 (910 star)
Metriche merge PR
 (Merge medio 16g 9h) (3 PR mergiate in 30 g)

Descrizione

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?

Guida contributor

Direzione di ricerca
Indaga come importare automaticamente funzioni non esportate nei doctest o fornire una sintassi più semplice per evitare il boilerplate ripetitivo di `setup`.
Tech stack
Nessuno
Dominio
documentationdeveloper experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JuliaDocumenter.jl
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70