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

Small cleanups #1058

Merged
merged 1 commit into from Aug 19, 2017
Merged

Small cleanups #1058

merged 1 commit into from Aug 19, 2017

Conversation

filiphr
Copy link
Contributor

@filiphr filiphr commented Aug 19, 2017

This is some small Javadoc changes and cleanups:

  • Add some missing since tags
  • Make the ConfigurationProvider constructor private
  • Do some rewording and fix some typos around the new SPI Representation

I think that the most important change here is that the META-INF/services folder needs to be in src/test/resources and not src/main/resources. Users usually have a test scoped dependency of AssertJ.

I've also fixed some small typos that I saw and I added the recommended way of writing a custom Representation. I think it is much easier for the users if they just extend the StandardRepresentation and override fallbackToStringOf(Object) method, this way they won't mess with all the defaults from AssertJ.

* Add some missing since tags
* Make the ConfigurationProvider constructor private
* Do some rewording and fix some typos around the new SPI Representation
* <li>make sure {@code META-INF/services/org.assertj.core.presentation.Representation} is in the runtime classpath, usually putting it in {@code src/main/resources} is enough</li>
* <li>make sure {@code META-INF/services/org.assertj.core.presentation.Representation} is in the runtime classpath, usually putting it in {@code src/test/resources} is enough</li>
* <li>we recommend that you extend from the {@link StandardRepresentation} and override the
* {@link StandardRepresentation#fallbackToStringOf(Object)}. By doing this all the defaults of AssertJ would be applied and you can apply your own customization</li>
Copy link
Member

Choose a reason for hiding this comment

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

good one for using src/test/resources, will do it and also override fallbackToStringOf in assertj-examples

@joel-costigliola joel-costigliola merged commit e8c99c3 into assertj:2.x Aug 19, 2017
@joel-costigliola
Copy link
Member

Good fixes thanks.

@filiphr filiphr deleted the small-cleanups branch August 19, 2017 08:17
@filiphr
Copy link
Contributor Author

filiphr commented Aug 19, 2017

No problem. Glad that you liked them, and sorry for not making them earlier, I was supposed to do them in the initial PR 😄

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

2 participants