Skip to content

Correct comment in test examples #4822

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

darth-raijin
Copy link

Changes:

  • A comment line was unecessarily split, this PR seeks to improve the readability and clean that line comment up

Signed-off-by: Mohamed Macow <[email protected]>
@fmbenhassine
Copy link
Contributor

This formatting is done by the spring-javaformat plugin, you can try it with: ./mvnw spring-javaformat:apply.

But we can make that comment more readable with something like:

// the manager sent 2 chunks ({1, 2, 3} and {4, 5, 6}) to workers
assertEquals("Waited for 2 results.", jobExecution.getExitStatus().getExitDescription());

If you update the PR accordingly, it should be good to merge.

@fmbenhassine fmbenhassine added pr-for: enhancement status: waiting-for-reporter Issues for which we are waiting for feedback from the reporter labels Jun 3, 2025
@darth-raijin
Copy link
Author

Alright, thank you for explaining how the formatting was done!

After the suggested change, we have landed on this:

// then
// the manager sent 2 chunks ({1, 2, 3} and {4, 5, 6}) to workers
assertEquals(ExitStatus.COMPLETED.getExitCode(), jobExecution.getExitStatus().getExitCode());

However it could also look like below, which should be more readable as well, and plays well into the given, when and then

// then the manager sent 2 chunks ({1, 2, 3} and {4, 5, 6}) to workers
assertEquals(ExitStatus.COMPLETED.getExitCode(), jobExecution.getExitStatus().getExitCode());

@fmbenhassine fmbenhassine added status: feedback-provided Issues for which the feedback requested from the reporter was provided and removed status: waiting-for-reporter Issues for which we are waiting for feedback from the reporter labels Jun 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-for: enhancement status: feedback-provided Issues for which the feedback requested from the reporter was provided
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants