Incorrect code example in documentation #4550
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
fmbenhassine
reviewed
Mar 7, 2024
| @@ -122,7 +122,7 @@ public class FileDeletingTasklet implements Tasklet, InitializingBean { | |||
| public RepeatStatus execute(StepContribution contribution, | |||
| ChunkContext chunkContext) throws Exception { | |||
| File dir = directory.getFile(); | |||
| Assert.state(dir.isDirectory()); | |||
| Assert.state(dir.isDirectory(), "Directory does not exist"); | |||
There was a problem hiding this comment.
Good catch! The message is missing and the code example does not compile. However, the message here is inaccurate, it would be appropriate if the assertion was dir.exists(). It should rather be something like "The resource must be a directory". Do you agree?
There was a problem hiding this comment.
Yes. I updated the message. Thanks:)
fmbenhassine
added
the
status: waiting-for-reporter
fmbenhassine
changed the title
fmbenhassine
pushed a commit
that referenced
this pull request
Mar 8, 2024
|
Thank you for the update! LGTM now 👍 Rebased and merged as 6334fbf. Thank you for your contribution! |
fmbenhassine
added
pr-for: bug
in: documentation
and removed
status: waiting-for-reporter
fmbenhassine
pushed a commit
that referenced
this pull request
Mar 8, 2024
fmbenhassine
added
the
for: backport-to-5.1.x
fmbenhassine
added
the
for: backport-to-5.0.x
FBibonne
pushed a commit
to FBibonne/spring-batch
that referenced
this pull request
Feb 2, 2025
Issue spring-projects#4550 Signed-off-by: Fabrice Bibonne <fabrice.bibonne@gmail.com>
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.
Assert.state(dir.isDirectory())was missing.