JuliaDocs/Documenter.jl

Show the error message on purpose?

Open

#1,420 opened on Sep 21, 2020

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

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 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.

Contributor guide

Research direction
Investigate how Documenter.jl currently handles code blocks that produce errors. Look for the 'warning' that is issued instead of displaying the error. Consider adding an option to control error display behavior, such as a custom block or a configuration flag.
Tech stack
julia
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JuliaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75