JuliaDocs/Documenter.jl

Debugging failing links in docstrings from other packages.

Open

#2,053 建立於 2023年2月21日

在 GitHub 查看
 (0 留言) (1 反應) (0 負責人)Julia (513 fork)batch import
Type: Enhancementhelp wanted

倉庫指標

Star
 (910 star)
PR 合併指標
 (平均合併 16天 9小時) (30 天內合併 3 個 PR)

描述

If you have documentation that pools docstrings from various packages, it becomes cumbersome to track down where failing links are located.

Could Documenter print the page the error is occurring on? I think it already does this for cross references. Capture https://buildkite.com/julialang/diffeqdocs-dot-jl/builds/14#018673f4-48b0-4668-b3ad-f3d119762be2/1245-1848 (Picture included since link will be inaccessible to most.)

貢獻者指南

研究方向
檢查 Documenter.jl 中的鏈接驗證模塊，找到打印損壞鏈接錯誤的位置。將源頁面 URL 添加到錯誤消息中。
技術棧
無
領域
documentation
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
JuliaDocumenter.jl
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70