JuliaDocs/Documenter.jl

Easier doctests of non-exported functions

Aberta

#2.126 aberto em 21 de mai. de 2023

Ver no GitHub
 (9 comentários) (0 reação) (0 responsável)Julia (513 forks)batch import
Topic: UsabilityType: Enhancementhelp wanted

Métricas do repositório

Stars
 (910 estrelas)
Métricas de merge de PR
 (Mesclagem média 16d 9h) (3 fundiu PRs em 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?

Guia do colaborador

Direção de pesquisa
Investigue como importar automaticamente funções não exportadas em doctests ou fornecer uma sintaxe mais simples para evitar o boilerplate repetitivo de `setup`.
Pilha de tecnologia
None
Domain
documentationdeveloper experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JuliaDocumenter.jl
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70