JuliaDocs/Documenter.jl

Debugging failing links in docstrings from other packages.

Open

#2.053 aberto em 21 de fev. de 2023

Ver no GitHub
 (0 comments) (1 reaction) (0 assignees)Julia (513 forks)batch import
Type: 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

If you have documentation that pools docstrings from various packages, it becomes cumbersome to track down where failing links are located.

Could Documenter print the page the error is occurring on? I think it already does this for cross references. Capture https://buildkite.com/julialang/diffeqdocs-dot-jl/builds/14#018673f4-48b0-4668-b3ad-f3d119762be2/1245-1848 (Picture included since link will be inaccessible to most.)

Guia do colaborador

Direção de pesquisa
Examine o módulo de validação de links no Documenter.jl para encontrar onde os erros de links quebrados são impressos. Adicione a URL da página de origem à mensagem de erro.
Pilha de tecnologia
None
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.
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