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

Incorrect JavaDoc for Methods returning JobFlowBuilder in JobBuilder #4415

Closed
PhiSch19 opened this issue Jul 13, 2023 · 2 comments
Closed

Incorrect JavaDoc for Methods returning JobFlowBuilder in JobBuilder #4415

PhiSch19 opened this issue Jul 13, 2023 · 2 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 type: bug
Milestone
5.1.0

Comments

@PhiSch19
Copy link

PhiSch19 commented Jul 13, 2023 •
edited
Loading

The JavaDoc links to SimpleJobBuilder but the method returns JobFlowBuilder:

https://github.com/spring-projects/spring-batch/blob/972951a40af03c9c0553fb4c438f9aaeb1c9f1b5/spring-batch-core/src/main/java/org/springframework/batch/core/job/builder/JobBuilder.java#L65C8-L65C8

https://github.com/spring-projects/spring-batch/blob/972951a40af03c9c0553fb4c438f9aaeb1c9f1b5/spring-batch-core/src/main/java/org/springframework/batch/core/job/builder/JobBuilder.java#L74C5-L74C5

If its not intended, I could create a PR.
@PhiSch19 PhiSch19 added the status: waiting-for-triage Issues that we did not analyse yet label Jul 13, 2023
@fmbenhassine
Copy link
Contributor

That's a valid issue. Thank you for reporting it!

You are welcome to contribute. Thank you fro your offer to help!

@fmbenhassine fmbenhassine added in: documentation type: bug 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 and removed status: waiting-for-triage Issues that we did not analyse yet labels Nov 17, 2023
@fmbenhassine fmbenhassine added this to the 5.1.0 milestone Nov 20, 2023
@fmbenhassine
Copy link
Contributor

This was actually resolved as part of 3fe3b7f.

@fmbenhassine fmbenhassine changed the title JobBuilder - JavaDoc for Methods returning JobFlowBuilder Incorrect JavaDoc for Methods returning JobFlowBuilder in JobBuilder Nov 20, 2023
fmbenhassine added a commit that referenced this issue Nov 20, 2023
@fmbenhassine
Fix JavaDoc in JobBuilder
8ad6d80 
Issue #4415
fmbenhassine added a commit that referenced this issue Nov 20, 2023
@fmbenhassine
Fix JavaDoc in JobBuilder
e022216 
Issue #4415
This was referenced Nov 20, 2023
Closed
Closed
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-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 type: bug
Projects
None yet
Milestone
5.1.0
Development

No branches or pull requests
2 participants
@fmbenhassine @PhiSch19