JuliaDocs/Documenter.jl

Avoid checking same link multiple times?

Open

#1 700 ouverte le 16 sept. 2021

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Julia (513 forks)batch import
Type: Enhancementhelp wanted

Métriques du dépôt

Stars
 (910 stars)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Le problème suggère de dédupliquer les vérifications de liens. Examinez la logique de vérification des liens dans Documenter.jl, probablement dans les fichiers sources liés à la validation des liens. Implémentez un cache des URL déjà vérifiées pour éviter les requêtes redondantes. Envisagez d'utiliser un ensemble ou un dictionnaire pour suivre les URL et leurs résultats. Le changement est localisé et ne nécessite pas une connaissance approfondie de l'ensemble de la base de code.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Julia
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65