JuliaDocs/Documenter.jl

Show the error message on purpose?

Open

#1 420 ouverte le 21 sept. 2020

Voir sur GitHub
 (12 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

I wanted to show some error message in the docs on purpose, but I realized that (by default) Documenter.jl is not going to show it, but give a warning in the docs build step. Is there an easy hack how to display the error warning? Ideally, I wouldn't want to distract the reader with display details, so I'd like to show only the call that would trigger the error.

Guide contributeur

Direction de recherche
Examinez comment Documenter.jl gère actuellement les blocs de code qui produisent des erreurs. Recherchez l'émission d'un 'avertissement' au lieu d'afficher l'erreur. Envisagez d'ajouter une option pour contrôler le comportement d'affichage des erreurs, telle qu'un bloc personnalisé ou un indicateur de configuration.
Stack technique
julia
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.
Plutôt claire
Prérequis
JuliaGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75