JuliaDocs/Documenter.jl

Easier doctests of non-exported functions

Ouverte

#2 126 ouverte le 21 mai 2023

Voir sur GitHub
 (9 commentaires) (0 réaction) (0 personne assignée)Julia (513 forks)batch import
Topic: UsabilityType: Enhancementhelp wanted

Métriques du dépôt

Stars
 (910 étoiles)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

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

Direction de recherche
Étudiez comment importer automatiquement des fonctions non exportées dans les doctests ou fournir une syntaxe plus simple pour éviter le code passe partout répétitif de `setup`.
Stack technique
Aucun
Domaine
documentationdeveloper experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JuliaDocumenter.jl
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70