JuliaDocs/Documenter.jl

Better error message when no doc found

Open

#1,996 建立於 2022年12月14日

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

倉庫指標

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

描述

Today we had this error in our CI pipeline that puzzled us for quite some time:

Error: no doc found for reference '[`is_pure`](@ref)' in src/abelian/structural.md

We eventually figured it out; but what would have helped us a lot would have been if there had been also a line number (or at least a rough range) within src/abelian/structural.md where the error was triggered.

In this case, the @ref was not in the .md file but rather was from a docstring. So it would have been extremely helpful to be told that, too: i.e. something like "from docstring of function Foo in file src/bar.jl:123" or whatever.

貢獻者指南