Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation by link getUpstreamCheckerNames and getSuppressWarningsPrefixes #1016

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Ao-senXiong
Copy link
Member

Fixes #1011

Copy link
Member

@wmdietl wmdietl left a comment

Choose a reason for hiding this comment

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

I think the point of #1011 was to improve the documentation of these methods in BaseTypeChecker. That documentation should make clear that these two methods likely want similar behavior.
The improvement here might be good, but please also look at BaseTypeChecker (and also check whether these methods are overridden elsewhere).

@wmdietl wmdietl assigned Ao-senXiong and unassigned wmdietl Dec 20, 2024
@Ao-senXiong
Copy link
Member Author

Thanks! Since those two methods are in sourcechecker, I noticed there are five overrides for getSuppressWarningsPrefixes in FenumChecker, InitializationChecker, NullnessNonInitSubChecker, SubtypingChecker and UnitsChecker. While
getUpstreamCheckerNames only have two overrides in InitializationChecker and InitializationFieldAccessChecker.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve the documentation for getSuppressWarningsPrefixes and getUpstreamCheckerNames
2 participants