DanielCarter-stack commented on issue #10544:
URL: https://github.com/apache/seatunnel/issues/10544#issuecomment-3976708467
<!-- code-pr-reviewer -->
This issue is well-scoped and ready to pick up. I've verified that all 7
target methods in `CoordinatorService.java` currently lack Javadoc:
- `startPendingJobScheduleThread()` (L227)
- `pendingJobSchedule()` (L250)
- `completeFailJob(JobMaster, ...)` (L334)
- `restoreAllRunningJobFromMasterNodeSwitch()` (L449)
- `restoreJobFromMasterActiveSwitch(Long, JobInfo)` (L506)
- `checkNewActiveMaster()` (L539)
- `clearCoordinatorService()` (L566)
The issue description already provides clear guidance on what each Javadoc
should cover. For style reference, see existing Javadoc examples in the same
file at L118-124 (field documentation) and L886-889 (method documentation).
Contributors should follow the project's Javadoc conventions: use `/** */`
format, `<p>` for paragraphs, and `{@link}` for referencing related types like
`JobMaster`, `PendingJobQueue`, and `Hazelcast`. After adding documentation,
run `./mvnw spotless:apply` followed by `./mvnw -q -DskipTests verify` to
ensure formatting and compilation pass.
This is a valuable documentation improvement since these methods handle core
scheduling and HA logic in the Zeta engine.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
