JuliaDocs/Documenter.jl

Debugging failing links in docstrings from other packages.

Open

#2 053 ouverte le 21 févr. 2023

Voir sur GitHub
 (0 commentaires) (1 réaction) (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

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

Guide contributeur

Direction de recherche
Examinez le module de validation des liens dans Documenter.jl pour trouver où les erreurs de liens cassés sont imprimées. Ajoutez l'URL de la page source au message d'erreur.
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.
1-3 heures
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
JuliaDocumenter.jl
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70