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

CustomDeclarationOrderCheck: Correct spelling of DeclareAnonClassField #656

Closed
jsoref opened this issue Apr 3, 2018 · 4 comments
Closed

CustomDeclarationOrderCheck: Correct spelling of DeclareAnonClassField #656

jsoref opened this issue Apr 3, 2018 · 4 comments

Comments

@jsoref
Copy link
Contributor

@jsoref jsoref commented Apr 3, 2018

To date, the annotation is DeclareAnnonClassField(...), but conceptually, it's trying to describe "declare an anonymous class field", the proper abbreviation for anonymous should be anon, not annon (which would be an abbreviation for annonymous [sic]), and thus the correct annotation should be DeclareAnonClassField(...).

Migration for users

If you use DeclareAnnonClassField in your configuration for this Check, please rename it to DeclareAnonClassField.

@rnveach
Copy link
Contributor

@rnveach rnveach commented Apr 3, 2018

@jsoref This doesn't explain anything like name of check being affected and why it is being renamed.
Please update issue and title to be more descriptive.

jsoref added a commit to jsoref/sevntu.checkstyle that referenced this issue Apr 3, 2018
@romani romani changed the title Correct spelling of DeclareAnonClassField CustomDeclarationOrderCheck: Correct spelling of DeclareAnonClassField Apr 4, 2018
@romani
Copy link
Member

@romani romani commented Apr 4, 2018

@jsoref, please explain users how to migrate, what they should change in theirs config file. In your commit you have example, just place it to description

@rnveach
Copy link
Contributor

@rnveach rnveach commented Apr 4, 2018

I added migration section.

jsoref added a commit to jsoref/sevntu.checkstyle that referenced this issue Apr 4, 2018
romani added a commit that referenced this issue Apr 6, 2018
@romani romani added this to the 1.29.0 milestone Apr 6, 2018
@romani
Copy link
Member

@romani romani commented Apr 6, 2018

fix is merged

@romani romani closed this Apr 6, 2018
kariem added a commit to kariem/sevntu.checkstyle that referenced this issue Jul 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants