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

Unused messages in message.properties #5094

Closed
ps-sp opened this Issue Sep 8, 2017 · 4 comments

Comments

Projects
None yet
5 participants
@ps-sp
Collaborator

ps-sp commented Sep 8, 2017

javadoc.parse.error at JavadocDetailNodeParser.java#L83 is just used at AbstractJavadocCheck.java#L71 to declare a constant which itself is never used anywhere.

We already utilize javadoc.parse.rule.error for reporting parse errors which makes javadoc.parse.error somewhat obsolete and something that other users won't need either. So the property should be removed.

Also, this hints at the existence of other such obsolete message keys in .properties files. The message keys that we provide for the general user and the message keys that shouldn't have any utility any more should be separated from each other after proper investigation and the obsolete message keys should be removed.

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Sep 8, 2017

Member

right:

$ grep -R "MSG_KEY_PARSE_ERROR" src/*
src/main/java/com/puppycrawl/tools/checkstyle/JavadocDetailNodeParser.java:    public static final String MSG_KEY_PARSE_ERROR = "javadoc.parse.error";
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheck.java:    public static final String MSG_KEY_PARSE_ERROR =
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheck.java:            JavadocDetailNodeParser.MSG_KEY_PARSE_ERROR;

Member

romani commented Sep 8, 2017

right:

$ grep -R "MSG_KEY_PARSE_ERROR" src/*
src/main/java/com/puppycrawl/tools/checkstyle/JavadocDetailNodeParser.java:    public static final String MSG_KEY_PARSE_ERROR = "javadoc.parse.error";
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheck.java:    public static final String MSG_KEY_PARSE_ERROR =
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheck.java:            JavadocDetailNodeParser.MSG_KEY_PARSE_ERROR;

@romani romani added the approved label Sep 8, 2017

@Vladlis Vladlis added the easy label Sep 14, 2017

@checkstyle checkstyle deleted a comment from sammy1997 Oct 25, 2017

@dyominov

This comment has been minimized.

Show comment
Hide comment
@dyominov

dyominov Oct 25, 2017

Contributor

I am on it.

If I right understand I`m need delete from properties and class all items javadoc.parse.error and rewrite testcase?

Contributor

dyominov commented Oct 25, 2017

I am on it.

If I right understand I`m need delete from properties and class all items javadoc.parse.error and rewrite testcase?

@rnveach

This comment has been minimized.

Show comment
Hide comment
@rnveach

rnveach Oct 25, 2017

Member

@dyominov That is correct but based on romani's comment, it isn't used directly in any test.

Member

rnveach commented Oct 25, 2017

@dyominov That is correct but based on romani's comment, it isn't used directly in any test.

rnveach added a commit that referenced this issue Oct 28, 2017

@rnveach

This comment has been minimized.

Show comment
Hide comment
@rnveach

rnveach Oct 28, 2017

Member

fix was merged

Member

rnveach commented Oct 28, 2017

fix was merged

@rnveach rnveach closed this Oct 28, 2017

@rnveach rnveach added this to the 8.4 milestone Oct 28, 2017

timurt added a commit to timurt/checkstyle that referenced this issue Dec 19, 2017

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