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

Fix and simplify documented example compiler output #297

Merged
merged 1 commit into from
Oct 13, 2022

Conversation

japborst
Copy link
Member

Full output when running in an example project below (with <showWarnings>true</showWarnings>)

As one is an INFO message and the other a COMPILATION WARNING I've cleaned the result up.

[INFO] /Users/japborst/Documents/dev/error-prone-demo/src/main/java/com/example/Example.java:[9,34] [Refaster Rule] BigDecimalRules.BigDecimalZero: Refactoring opportunity
    (see https://error-prone.picnic.tech/refasterrules/BigDecimalRules#BigDecimalZero)
  Did you mean 'return BigDecimal.ZERO;'?
[INFO] -------------------------------------------------------------
[WARNING] COMPILATION WARNING :
[INFO] -------------------------------------------------------------
[WARNING] /Users/japborst/Documents/dev/error-prone-demo/src/main/java/com/example/Example.java:[14,35] [IdentityConversion] This method invocation appears redundant; remove it or suppress this warning and add a comment explaining its purpose
    (see https://error-prone.picnic.tech/bugpatterns/IdentityConversion)
  Did you mean 'return set;' or '@SuppressWarnings("IdentityConversion") public ImmutableSet<Integer> getSet() {'?
[INFO] 1 warning
[INFO] -------------------------------------------------------------
[INFO] -------------------------------------------------------------
[ERROR] COMPILATION ERROR :
[INFO] -------------------------------------------------------------
[ERROR] warnings found and -Werror specified
[INFO] 1 error

Copy link
Member

@Stephan202 Stephan202 left a comment

Choose a reason for hiding this comment

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

Tnx! Suggested commit message:

Fix and simplify documented example compiler output (#297)

Copy link
Member

@rickie rickie left a comment

Choose a reason for hiding this comment

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

It will be cool to show this today as well, so let's roll with it!!!

Copy link
Member

@Badbond Badbond left a comment

Choose a reason for hiding this comment

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

Looking good! Thanks! 👍

@japborst japborst changed the title Update README to include Refaster url upon suggested fix Fix and simplify documented example compiler output Oct 13, 2022
@japborst japborst merged commit a2559bd into master Oct 13, 2022
@japborst japborst deleted the japborst/update-refaster-url branch October 13, 2022 08:12
@Stephan202 Stephan202 added this to the 0.5.0 milestone Oct 15, 2022
@rickie rickie added the documentation A documentation update label Oct 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation A documentation update
Development

Successfully merging this pull request may close these issues.

4 participants