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