JuliaDocs/Documenter.jl

Easier doctests of non-exported functions

Open

#2 126 ouverte le 21 mai 2023

Voir sur GitHub
 (9 commentaires) (0 réactions) (0 assignés)Julia (910 stars) (513 forks)batch import
Topic: UsabilityType: Enhancementhelp wanted

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?

Guide contributeur

Stack technique
Aucun
Domaine
documentationtesting
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Julia programmingDocumenter.jl basicsDoctest setup mechanics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
Explore the codebase for how doctests are processed, likely in src/DocHelpers.jl or src/doctests.jl. Consider adding a keyword argument or configuration to allow automatic import of the module's functions. Review comments in the issue for potential approaches discussed.