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.

Sign up for GitHub

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

Jump to bottom

Misleading documentation on ItemWriteListener #4400

Closed
littlewoo opened this issue Jun 20, 2023 · 2 comments
Closed

Misleading documentation on ItemWriteListener #4400

littlewoo opened this issue Jun 20, 2023 · 2 comments
Labels
for: backport-to-5.0.x Issues that will be back-ported to the 5.0.x line for: backport-to-5.1.x Issues that will be back-ported to the 5.1.x line in: documentation type: enhancement
Milestone
5.2.0-M1

Comments

@littlewoo
Copy link

The reference doc for ItemWriteListener says:

The afterWrite method is called after the item has been successfully written

However, digging into the Javadoc for ItemWriteListener, it seems otherwise:

This is called before any transaction is committed

"after successfully written" suggests that the transaction will have already been committed. The reference documentation should be updated to specify that "after successfully written" actually means before the transaction is committed (i.e. during the write, not after it).
@littlewoo littlewoo added the status: waiting-for-triage Issues that we did not analyse yet label Jun 20, 2023
@fmbenhassine fmbenhassine added in: documentation type: enhancement and removed status: waiting-for-triage Issues that we did not analyse yet labels Jul 10, 2023
@hwan33
Copy link
Contributor

hwan33 commented Nov 3, 2023

Can i work on this issue?

@fmbenhassine
Copy link
Contributor

@hwan33 Sure!

As a rule of thumb, no need to ask for contributions. Any issue not tagged with status: for-internal-team is open for contributions. Look for issues tagged with status: ideal-for-contribution as well. Thank you for your offer to help!

hwan33 added a commit to hwan33/spring-batch that referenced this issue Nov 18, 2023
@hwan33
Revise the documentation to correct misleading information regarding …
022ccd1 
…the ItemWriteListener.

resolves spring-projects#4400
@hwan33 hwan33 mentioned this issue Nov 18, 2023
Closed
@fmbenhassine fmbenhassine added this to the 5.2.0 milestone Mar 11, 2024
@fmbenhassine fmbenhassine added for: backport-to-5.1.x Issues that will be back-ported to the 5.1.x line for: backport-to-5.0.x Issues that will be back-ported to the 5.0.x line labels Mar 11, 2024
@fmbenhassine fmbenhassine changed the title Documentation on ItemWriteListener is misleading. Misleading documentation on ItemWriteListener Mar 11, 2024
fmbenhassine pushed a commit that referenced this issue Mar 11, 2024
@hwan33 @fmbenhassine
Fix misleading documentation regarding the ItemWriteListener
dbb4e21 
Resolves #4400
@fmbenhassine fmbenhassine mentioned this issue Mar 11, 2024
Closed
fmbenhassine added a commit that referenced this issue Mar 11, 2024
@fmbenhassine
Fix misleading documentation regarding the ItemWriteListener
f56a21c 
Backported from e785391

Issue #4400
@fmbenhassine fmbenhassine mentioned this issue Mar 11, 2024
Closed
@fmbenhassine fmbenhassine modified the milestones: 5.2.0, 5.2.0-M1 Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
for: backport-to-5.0.x Issues that will be back-ported to the 5.0.x line for: backport-to-5.1.x Issues that will be back-ported to the 5.1.x line in: documentation type: enhancement
Projects
None yet
Milestone
5.2.0-M1
Development

No branches or pull requests
3 participants
@fmbenhassine @littlewoo @hwan33