Handle bad doc metadata better in at-autodocs #1811
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When running into the call syntax issue in #1810 or #1192, at-autodocs will now issue a standard documenter error/warning:
If strict error checking is disabled, then these docstrings will simply get omitted from the at-autodocs block. This will close #1810 and close #1192 on Documenter's end, but the upstream issue JuliaLang/julia#45174 still needs to be addressed.
In addition, this add the
Documenter.except
function to easily disable strict checking on some error types (as opposed to having to list all, except a few manually):And we also now print the error classes that cause
makedocs
to terminate, so that it would be easier to figure out which error classes toexcept
, if that is something the user wants / needs to do.