QL: improve the "this block-comment should have been a QLDoc"-query #11294
Conversation
This file contains hidden or 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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
geoffw0
approved these changes
Nov 17, 2022
| node instanceof TopLevel and | ||
| comment = getCommentAtStart(node.getLocation().getFile(), 1) and | ||
| nodeDescrip = "the file" | ||
| ) and |
There was a problem hiding this comment.
It feels like we could remove some redundant logic here by adding a reason parameter to getACommentThatCouldBeQLDoc returning "the below code" or "the file".
There was a problem hiding this comment.
Yeah, that could save some duplication.
But that sounds like something for a followup, this seems good enough to merge.
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.
This would have caught a recent QLDoc check that I spent way too long trying to fix, where I didn't realise that the top-level comment was not a QLDoc.
I also fixed a whole bunch of the issues found by the query.
Not all, some results are benign.
And also some improvements to how we match up QLDoc in QL-for-QL.