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

Incorrect Javadoc in SimpleStepBuilder #4402

Closed
fmbenhassine opened this issue Jun 22, 2023 · 3 comments
Closed

Incorrect Javadoc in SimpleStepBuilder #4402

fmbenhassine opened this issue Jun 22, 2023 · 3 comments
Labels
for: backport-to-4.3.x Issues that will be back-ported to the 4.3.x line for: backport-to-5.0.x Issues that will be back-ported to the 5.0.x line in: documentation status: first-timers-only Issues that we would like first-timers only to work on type: bug
Milestone

Comments

@fmbenhassine
Copy link
Contributor

The Javadoc on SimpleStepBuilder is incorrect here:

Step builder for simple item processing (chunk oriented) steps. Items are read and cached in chunks,
and then processed (transformed) and written (optionally either the processor or the writer can be omitted)
all in the same transaction.

The item writer is mandatory in a chunk-oriented step, only the item processor is optional. The goal of this issue is to change the Javadoc as follows:

--optionally either the processor or the writer can be omitted
++optionally the processor can be omitted
@fmbenhassine fmbenhassine added in: documentation type: bug status: first-timers-only Issues that we would like first-timers only to work on for: backport-to-4.3.x Issues that will be back-ported to the 4.3.x line for: backport-to-5.0.x Issues that will be back-ported to the 5.0.x line labels Jun 22, 2023
@fmbenhassine fmbenhassine added this to the 5.1.0 milestone Jun 22, 2023
@seonWKim
Copy link
Contributor

Hi @fmbenhassine, thank you for the "first-timers-only" issue. May be I can start my contribution to spring batch from here 😄 . I've created a PR.

@fmbenhassine
Copy link
Contributor Author

fmbenhassine commented Jul 10, 2023

@seonwoo960000 Great! Thank you for your help and for opening your first PR 🎉

@seonWKim
Copy link
Contributor

@fmbenhassine It's a pleasure. Hope to contribute more to greate spring batch project.

fmbenhassine pushed a commit that referenced this issue Jul 17, 2023
Resolves #4402

Author: Seon Woo Kim <seronwoo960000.kim@gmail.com>
(cherry picked from commit 1c48223)
fmbenhassine pushed a commit that referenced this issue Jul 17, 2023
Resolves #4402

Author: Seon Woo Kim <seronwoo960000.kim@gmail.com>
@fmbenhassine fmbenhassine modified the milestones: 5.1.0, 5.1.0-M1 Jul 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
for: backport-to-4.3.x Issues that will be back-ported to the 4.3.x line for: backport-to-5.0.x Issues that will be back-ported to the 5.0.x line in: documentation status: first-timers-only Issues that we would like first-timers only to work on type: bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants