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 type of date/time fields in documentation #4324

Closed
swapy opened this issue Mar 14, 2023 · 2 comments · Fixed by swapy/spring-batch#1
Closed

Incorrect type of date/time fields in documentation #4324

swapy opened this issue Mar 14, 2023 · 2 comments · Fixed by swapy/spring-batch#1
Labels
in: documentation type: bug
Milestone
5.0.2

Comments

@swapy
Copy link
Contributor

swapy commented Mar 14, 2023

I found small issue in documentation where we mention datetime with java.util.Date but in reality spring batch has moved to new java classes java.time.LocalDateTime. So this needs to be fixed in docs.

Places to change:

  1. https://docs.spring.io/spring-batch/docs/current/reference/html/index-single.html#jobexecution
  • startTime
  • endTime
  • createTime
  • lastUpdated
  1. https://docs.spring.io/spring-batch/docs/current/reference/html/index-single.html#stepexecution
  • startTime
  • endTime
@swapy swapy added status: waiting-for-triage Issues that we did not analyse yet type: bug labels Mar 14, 2023
@fmbenhassine
Copy link
Contributor

Good catch! Thank you for raising this. Contributions are welcome.

@fmbenhassine fmbenhassine added in: documentation status: ideal-for-contribution Issues that are ideal for contribution by the community and removed status: waiting-for-triage Issues that we did not analyse yet labels Mar 14, 2023
@swapy swapy mentioned this issue Mar 15, 2023
Merged
@swapy
Copy link
Contributor Author

swapy commented Mar 15, 2023

Have created a pull request
#4324

@fmbenhassine fmbenhassine removed the status: ideal-for-contribution Issues that are ideal for contribution by the community label Mar 21, 2023
@fmbenhassine fmbenhassine added this to the 5.0.2 milestone Mar 21, 2023
@fmbenhassine fmbenhassine changed the title Documentation should have correct classes for dates for all cases. Incorrect type of date/time fields in documentation Mar 21, 2023
fmbenhassine pushed a commit that referenced this issue Mar 21, 2023
@swapy @fmbenhassine
Fix type of date/time fields in documentation
1343eee 
This commit fixes a bug in the documentation of JobExecution
and StepExecution to point to `java.time.LocalDateTime` instead
of `java.util.Date`.

Resolves #4324
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
in: documentation type: bug
Projects
None yet
Milestone
5.0.2
Development

Successfully merging a pull request may close this issue.

Changed java.util.Date to java.time.LocalDateTime in docs. swapy/spring-batch
2 participants
@fmbenhassine @swapy