Autodoc: improve error reporting #22902
Merged
+100
−36
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.
This PR aims to improve error handling and reporting in Autodoc, to help address potentially confusing scenarios such as the one described here: https://ziggit.dev/t/file-has-unexpected-syntax-error-when-building-documentation/8387
There are several changes included:
console.error
,console.warn
, etc. instead ofconsole.log
(this brings several benefits, including colors in the browser console and stack traces for error logs).Screenshots of Autodoc with the following simple project:
s.zig
g.zig
(no newline at end of file)