JuliaDocs/Documenter.jl

Show the error message on purpose?

Open

#1,420 创建于 2020年9月21日

在 GitHub 查看
 (12 评论) (0 反应) (0 负责人)Julia (513 fork)batch import
Type: Enhancementhelp wanted

仓库指标

Star
 (910 star)
PR 合并指标
 (平均合并 16天 9小时) (30 天内合并 3 个 PR)

描述

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.

贡献者指南

研究方向
研究Documenter.jl当前如何处理产生错误的代码块。查找发出“警告”而不是显示错误的地方。考虑添加一个选项来控制错误显示行为，例如自定义块或配置标志。
技术栈
julia
领域
documentation
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
基本清晰
前置要求
JuliaGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75