JuliaDocs/Documenter.jl

Better "no docs found" error message

Open

#2,334 建立於 2023年11月6日

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

描述

Whenever I get the error message that reads

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

I can never remember if the problem is

  1. There is no docstring in the source code for this reference.
  2. There is no docstring included in the docs for this reference.
  3. Number 2 as a consequence of number 1.
  4. Number 2 as a consequence of rms not being exported.

Would it be possible to somehow be more precise in these error messages? For example, I was just debugging why I got the message above, and it turned out that

  1. I did have rms in a @docs block.
  2. rms did have a docstring in the source
  3. rms was not exported.

It took me quite a while to figure out that the problem was number 3 here, and it's not the first time :sweat_smile:

貢獻者指南

技術棧
無
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Julia programmingDocumenter.jl internals
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
The error message is likely generated in the build or processing pipeline for documentation references. Search for the string 'no doc found for reference' in the repository to locate the source. Examine how references are resolved and whether the cause (missing docstring, not exported, etc.) can be determined. Consider adding specific error messages for each case.
Better "no docs found" error message · JuliaDocs/Documenter.jl#2334 | Good First Issue