DanielCarter-stack commented on issue #10545: URL: https://github.com/apache/seatunnel/issues/10545#issuecomment-3976711740
<!-- code-pr-reviewer --> Thank you for the detailed documentation improvement proposal for `CheckpointCoordinator`. I've verified that the file exists at `seatunnel-engine/seatunnel-engine-server/src/main/java/org/apache/seatunnel/engine/server/checkpoint/CheckpointCoordinator.java` (1174 lines) and confirmed the Javadoc coverage is indeed very low (~2%), matching your description. All 10 methods and 5 fields listed in the issue exist and lack Javadoc. The line numbers are accurate (with minor offsets due to code evolution, which is normal). The related classes like `CheckpointType`, `CheckpointCloseReason`, `CheckpointCoordinatorStatus`, and `CheckpointPlan` (with `COORDINATOR_INDEX = -1`) are also present. **Key documentation areas to cover:** - State machine transitions: `WAITING_RESTORE` → `restoreTaskState()` → `READY_START` → `allTaskReady()` → `tryTriggerPendingCheckpoint()` → `acknowledgeTask()` → `completePendingCheckpoint()` - Field semantics: `readyToCloseStartingTask`/`readyToCloseIdleTask`/`closedIdleTask` (task lifecycle), `schemaChanging` (gate for DDL), `isAllTaskReady` (one-time gate) - Parallelism remapping logic in `restoreTaskState()` (lines 313-339) You can reference `docs/en/architecture/fault-tolerance/checkpoint-mechanism.md` (lines 125-150) for architecture context and existing enum classes for Javadoc style. This is a well-scoped, valuable improvement for #10533. Contributors should run `./mvnw spotless:apply` and `./mvnw -q -DskipTests verify` after changes. -- 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]
