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

Add rule to report discouraged comment locations #1365

Conversation

paul-dingemans
Copy link
Collaborator

@paul-dingemans paul-dingemans commented Feb 9, 2022

Description

Add rule to report discouraged comment locations

Autocorrect is not implemented. This is an error which only happens rarely. Its value is that it makes implementation of some rules way easier when comment do not have to be taken into account.

Initial implementation just contains one single discouraged location. More will follow when implementing the rule to rewrite the function signature automatically as is described in #1341.

Checklist

  • tests are added
  • CHANGELOG.md is updated

Paul Dingemans and others added 3 commits February 9, 2022 19:57
Autocorrect is not implemented. This is an error which only
happens rarely. Its value is that it makes implementation of
some rules way easier when comment do not have to be taken
into account.

Initial implementation just contains one single discouraged
location. More will follow when implementing the rule to
rewrite the function signature automatically as is described
in pinterest#1341.
@paul-dingemans paul-dingemans added this to the 0.45.0 milestone Mar 9, 2022
@paul-dingemans paul-dingemans merged commit ec1f3f3 into pinterest:master Mar 9, 2022
@paul-dingemans paul-dingemans deleted the 1341-discourage-comment-location-rule branch March 9, 2022 19:31
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.

None yet

1 participant