JuliaDocs/Documenter.jl

Avoid checking same link multiple times?

Open

#1700 aperta il 16 set 2021

Vedi su GitHub
 (0 commenti) (0 reazioni) (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

Right now, every link in the document is checked but in theory each unique URL only needs to be checked once. It's not a big concern, but I have seen some flaky servers that timeout a small fraction of the time, and so checking the link more than once gives more chance of timeout and also means more time waiting for these slow servers

Guida contributor

Direzione di ricerca
Il problema suggerisce di deduplicare i controlli dei collegamenti. Esamina la logica di controllo dei collegamenti in Documenter.jl, probabilmente nei file sorgente relativi alla convalida dei collegamenti. Implementa una cache degli URL già controllati per evitare richieste ridondanti. Considera l'uso di un insieme o di un dizionario per tracciare gli URL e i loro risultati. La modifica è localizzata e non richiede una conoscenza approfondita dell'intera codebase.
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.
Mezza giornata
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
Julia
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65