Diagnostics v3 #99
Merged
Diagnostics v3 #99
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Wrap parser diagnostics in a simple dataclass, with a helper for formatting the message.
Properly propagate error messages from _recursive_parse() all the way to Sphinx logging to improve diagnostics on comments above unexpected cursors. Also preserve the comments and output them as regular top level comments instead of just dropping them and replacing with diagnostics in the produced documentation. Fixes: #80
Extend the ErrorLevel enum to cover all Clang diagnostic levels. Use the Clang diagnostic levels as the values to avoid mapping in the parser, but this is an implementation detail. Make it an IntEnum to ensure the values are indeed ints. Map the ErrorLevel values to Sphinx verbosity levels and log level names in the extension, and avoid making assumptions about the values. The verbosity levels are a bit weird, but for now keep them functionally equivalent to what we had before. We may want to revisit them later. Assume the log level names we specify here are stable in Sphinx, and have Sphinx map them to its internal log level values within log().
BrunoMSantos
approved these changes
Dec 7, 2022
There was a problem hiding this comment.
Nice! Thanks for sticking with me :)
Just double check the last commit message. It states:
Start logging parser warnings at default verbosity level 0, parser info at verbosity level 1, and parser debug at verbosity level 1.
It mentions level 1 twice, whereas I believe you mean 2 for debug and verbosity levels.
Instead of having our own verbosity filtering, map parser diagnostics to level names that have the verbosity we want, and let Sphinx logging do the filtering behind the scenes. Start logging parser warnings at default verbosity level 0, parser info at verbosity level 1, and parser debug at verbosity level 2.
jnikula
force-pushed
the
diagnostics-v3
branch
from
64cf811 to
db02eec
Compare
Likewise! :) I really appreciate the review. Thanks!
D'oh! Fixed, thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Third time's the charm? Superseeds #98.