JuliaDocs/Documenter.jl

Debugging failing links in docstrings from other packages.

Open

#2053 aperta il 21 feb 2023

Vedi su GitHub
 (0 commenti) (1 reazione) (0 assegnatari)Julia (513 fork)batch import
Type: Enhancementhelp wanted

Metriche repository

Star
 (910 star)
Metriche merge PR
 (Merge medio 16g 9h) (3 PR mergiate in 30 g)

Descrizione

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.)

Guida contributor

Direzione di ricerca
Esamina il modulo di validazione dei link in Documenter.jl per trovare dove vengono stampati gli errori di link rotti. Aggiungi l'URL della pagina sorgente al messaggio di errore.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JuliaDocumenter.jl
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70