JuliaDocs/Documenter.jl

Debugging failing links in docstrings from other packages.

Open

#2,053 opened on 2023年2月21日

GitHub で見る
 (0 comments) (1 reaction) (0 assignees)Julia (513 forks)batch import
Type: Enhancementhelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (平均マージ 16d 9h) (30d で 3 merged PRs)

説明

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
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
JuliaDocumenter.jl
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70