docs: align README (main and sub-modules) with existing code#30
Conversation
- Updated the `DLCK` Table Schema (H2) example in the main README.md to accurately reflect the database script (`DATETIME` to `TIMESTAMP`, `int` to `BIGINT`).
- Updated the `KeyLock` interface documentation in `dlock-api/README.md` to precisely match the Javadocs in `KeyLock.java`, including `@throws LockException`.
- Fixed a minor Javadoc syntax issue in `KeyLock.java` (`{@link Optional#empty}` to `{@link Optional#empty()}`).
Co-authored-by: pmalirz <19637300+pmalirz@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
1 participant
This submission addresses the user's request to "align README (main and sub-modules) with existing code".
Changes include:
README.md): The SQL schema example for the H2 database previously listedCREATED_TIME DATETIMEandEXPIRE_SEC int. However, the actual database scripts (e.g.,dlock-jdbc/src/main/resources/db/H2-create.sql) and Java code expectTIMESTAMPand along(BIGINT). This has been corrected to ensure developers create the correct schema if they implement it manually.dlock-api/README.md): The code block documenting theKeyLockinterface was out-of-sync with the actualKeyLock.javafile. It was missing parameter documentation and the@throws io.github.pmalirz.dlock.api.exception.LockExceptionstatements. It has been updated to perfectly mirror the current Java interface.dlock-api/src/main/java/io/github/pmalirz/dlock/api/KeyLock.java): A minor typo in the Javadoc ({@link Optional#empty}) was corrected to the proper method reference syntax ({@link Optional#empty()}).All tests have been run and pass successfully.
PR created automatically by Jules for task 8286994299612409059 started by @pmalirz