Fix typos in method names and javadoc #40971
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…sure it is more understandable and coherent.
spring-projects-issues
added
the
status: waiting-for-triage
wilkinsona
requested changes
Jun 2, 2024
| @@ -3,7 +3,7 @@ | |||
|
|
|||
| The https://www.testcontainers.org/[Testcontainers] library provides a way to manage services running inside Docker containers. | |||
| It integrates with JUnit, allowing you to write a test class that can start up a container before any of the tests run. | |||
| Testcontainers is especially useful for writing integration tests that talk to a real backend service such as MySQL, MongoDB, Cassandra and others. | |||
| Testcontainers are especially useful for writing integration tests that talk to a real backend service such as MySQL, MongoDB, Cassandra and others. | |||
There was a problem hiding this comment.
This is referring to the Testcontainers open source project. It should be singular.
There was a problem hiding this comment.
I have updated the code accordingly. Thank you for the feedback.
| @@ -141,7 +141,7 @@ private void assertHasClassesOrLocations(MergedContextConfiguration mergedConfig | |||
| boolean hasClasses = !ObjectUtils.isEmpty(mergedConfig.getClasses()); | |||
| boolean hasLocations = !ObjectUtils.isEmpty(mergedConfig.getLocations()); | |||
| Assert.state(hasClasses || hasLocations, | |||
| () -> "No configuration classes or locations found in @SpringApplicationConfiguration. " | |||
| () -> "No configuration classes or locations are found in @SpringApplicationConfiguration. " | |||
There was a problem hiding this comment.
I don't think "are" is needed here.
There was a problem hiding this comment.
Changes have been made, thank you for the feedback as always.
| @@ -141,7 +141,7 @@ private void assertHasClassesOrLocations(MergedContextConfiguration mergedConfig | |||
| boolean hasClasses = !ObjectUtils.isEmpty(mergedConfig.getClasses()); | |||
| boolean hasLocations = !ObjectUtils.isEmpty(mergedConfig.getLocations()); | |||
| Assert.state(hasClasses || hasLocations, | |||
| () -> "No configuration classes or locations found in @SpringApplicationConfiguration. " | |||
| () -> "No configuration classes or locations are found in @SpringApplicationConfiguration. " | |||
There was a problem hiding this comment.
Adding "are" doesn't significantly improve clarity
…sure it is more understandable and coherent. - resolved feedbacks
wilkinsona
approved these changes
Jun 2, 2024
mhalbritter
changed the title
mhalbritter
added
type: documentation
mhalbritter
pushed a commit
that referenced
this pull request
Jun 3, 2024
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix typos in method names and javadoc; update the documentation to ensure it is more understandable and coherent.