JuliaDocs/Documenter.jl

Show the error message on purpose?

Open

#1.420 aberto em 21 de set. de 2020

Ver no GitHub
 (12 comments) (0 reactions) (0 assignees)Julia (513 forks)batch import
Type: Enhancementhelp wanted

Métricas do repositório

Stars
 (910 stars)
Métricas de merge de PR
 (Mesclagem média 16d 9h) (3 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Investigue como o Documenter.jl atualmente lida com blocos de código que produzem erros. Procure o 'aviso' que é emitido em vez de exibir o erro. Considere adicionar uma opção para controlar o comportamento de exibição de erro, como um bloco personalizado ou uma flag de configuração.
Pilha de tecnologia
julia
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
JuliaGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75