Skip to content

Conversation

@redsun82
Copy link
Contributor

The check for QLDoc comments was unfortunately broken for some time, so we missed this.

The check for QLDoc comments was unfortunately broken for some time, so
we missed this.
Copilot AI review requested due to automatic review settings November 19, 2025 11:01
@redsun82 redsun82 requested a review from a team as a code owner November 19, 2025 11:01
@github-actions github-actions bot added the Java label Nov 19, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds missing QLDoc documentation that was not caught due to a previously broken QLDoc comment checker. The change adds a documentation comment to a single method in the Java library.

  • Adds QLDoc comment to the getAUse() method in the SsaVariable class

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@redsun82 redsun82 added the no-change-note-required This PR does not need a change note label Nov 19, 2025
@aschackmull
Copy link
Contributor

The check for QLDoc comments was unfortunately broken for some time, so we missed this

I don't think it was broken? The alerts it generates are ephemeral so we sometimes ignore some of them for various reasons.

Copy link
Contributor

@aschackmull aschackmull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean sure, I'll approve, but I think this change was prompted by a misunderstanding of the ephemeral nature of the qldoc CI check.

@redsun82 redsun82 merged commit 240c637 into main Nov 20, 2025
23 of 24 checks passed
@redsun82 redsun82 deleted the redsun82/java-doc branch November 20, 2025 11:08
@redsun82
Copy link
Contributor Author

@aschackmull

The check for QLDoc comments was unfortunately broken for some time, so we missed this

I don't think it was broken? The alerts it generates are ephemeral so we sometimes ignore some of them for various reasons.

when I said broken, I didn't mean they were not passing: they were silently not being run at all because of a misconfiguration of the triggers. On the other hand, yes, maybe this wasn't entirely necessary either 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Java no-change-note-required This PR does not need a change note

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants