JuliaDocs/Documenter.jl

Better error message when no doc found

Open

#1.996 aberto em 14 de dez. de 2022

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)Julia (513 forks)batch import
Topic: UsabilityType: Enhancementhelp wanted

Métricas do repositório

Stars
 (910 stars)
Métricas de merge de PR
 (Mesclagem média 16d 9h) (3 fundiu PRs em 30d)

Description

Today we had this error in our CI pipeline that puzzled us for quite some time:

Error: no doc found for reference '[`is_pure`](@ref)' in src/abelian/structural.md

We eventually figured it out; but what would have helped us a lot would have been if there had been also a line number (or at least a rough range) within src/abelian/structural.md where the error was triggered.

In this case, the @ref was not in the .md file but rather was from a docstring. So it would have been extremely helpful to be told that, too: i.e. something like "from docstring of function Foo in file src/bar.jl:123" or whatever.

Guia do colaborador

Direção de pesquisa
Localize onde a mensagem de erro 'no doc found for reference' é gerada no Documenter.jl. Em seguida, adicione contexto como o número da linha no arquivo de origem ou o nome da docstring e seu arquivo. Veja o caminho do código que processa referências cruzadas.
Pilha de tecnologia
julia
Domain
documentation
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.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
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 basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65