JuliaDocs/Documenter.jl

Avoid checking same link multiple times?

Open

#1.700 geöffnet am 16. Sept. 2021

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (513 Forks)batch import
Type: Enhancementhelp wanted

Repository-Metriken

Stars
 (910 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Das Issue schlägt vor, Linkprüfungen zu deduplizieren. Schauen Sie sich die Linkprüflogik in Documenter.jl an, wahrscheinlich in den Quelldateien zur Linkvalidierung. Implementieren Sie einen Cache bereits geprüfter URLs, um redundante Anfragen zu vermeiden. Erwägen Sie die Verwendung einer Menge oder eines Wörterbuchs, um URLs und ihre Ergebnisse zu verfolgen. Die Änderung ist lokalisiert und erfordert keine tiefgehende Kenntnis der gesamten Codebasis.
Tech Stack
Keine
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Julia
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65