Stream: helpdesk (published)

Topic: Pinpoint Documenter missing_docs errors


view this post on Zulip DrChainsaw (Oct 15 2023 at 15:42):

I'm getting an error about a docstring not being included in the manual, but I can't find information on where this docstring is found:

 Error: 1 docstring not included in the manual:

     NaiveNASlib.Δsize! :: Tuple{AbstractVector{<:AbstractVertex}}

 These are docstrings in the checked modules (configured with the modules keyword)
 that are not included in canonical @docs or @autodocs blocks.
 @ Documenter ~/.julia/packages/Documenter/cxHBW/src/utilities/utilities.jl:44

Is there some way to print out the file and line number where Documenter found this docstring? Is there some other trick to pinpoint other than commenting out or deleting all methods/docstrings until the error goes away?

If I print the docstrings in the REPL I get four different docstring and from what I can tell all of those are listed in the manual using Documenter 0.27. To make matters a bit more annoying, the docs build correctly when I build them locally.

Full output: https://github.com/DrChainsaw/NaiveNASlib.jl/actions/runs/6518639379/job/17704281733?pr=107


Last updated: Nov 22 2024 at 04:41 UTC