Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve error message could not find input line in code block by indicating location of that code block #2601

Open
fingolfin opened this issue Nov 7, 2024 · 0 comments · May be fixed by #2602

Comments

@fingolfin
Copy link
Contributor

I just did execute makedocs with doctest = :fix in a package to adjust docstrings to some printing tweaks I made, and got this very frustrating message:

julia> include("docs/make.jl")
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doctests.
┌ Warning: could not find input line in code block
└ @ Documenter ~/.julia/packages/Documenter/C1XEF/src/doctests.jl:507

I call it frustrating because all I know now is that "some docstring somewhere in your package has a problem, maybe". That's not a lot to go on.

If I knew which docstring it was, at least I'd have a chance.

If there is any way to improve this message to tell me more, that'd be awesome. Ideally of course the file and starting line of the code block, but even just the file would be a great start. Or a snippet of the content. Anything?

@fingolfin fingolfin linked a pull request Nov 7, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant