JuliaDocs/Documenter.jl

Show the error message on purpose?

Open

#1420 aperta il 21 set 2020

Vedi su GitHub
 (12 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

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.

Guida contributor

Direzione di ricerca
Indaga come Documenter.jl gestisce attualmente i blocchi di codice che producono errori. Cerca l'emissione di 'avviso' invece di mostrare l'errore. Considera di aggiungere un'opzione per controllare il comportamento di visualizzazione degli errori, come un blocco personalizzato o un flag di configurazione.
Tech stack
julia
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.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
JuliaGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75