hansva commented on PR #9498:
URL: https://github.com/apache/hop/pull/9498#issuecomment-6918366803

   Thanks for this cleanup. The code changes look good to me. Three things 
before we merge:
   
   **1. The documentation still uses `getResult()`**
   
   - `docs/hop-user-manual/modules/ROOT/pages/workflow/actions/eval.adoc` (line 
127) tells JavaScript users to call `previous_result.getResult()`. Scripts 
written from that page will fail at runtime once the deprecated method is 
removed, so this one matters most. Please change it to 
`previous_result.isResult()`.
   - `docs/hop-dev-manual/modules/ROOT/pages/sdk/workflows.adoc` uses 
`result.getResult()` on lines 107, 114 and 151. This is the code plugin 
developers copy, so it should show `isResult()` too.
   
   **2. The `@deprecated` tag on `getResult()` lost its link**
   
   In `Result.java` the tag changed from `{@link #isResult()}` to plain 
`isResult()`. Without the link, IDEs can't jump to the replacement and Javadoc 
no longer checks that the method exists. Please keep `{@link #isResult()}`.
   
   **3. Explain why `isResult()` is written out**
   
   The class has `@Getter`, so the explicit `isResult()` looks redundant, but 
it isn't. Lombok skips the getter for the boolean `result` because 
`getResult()` already exists. If someone later deletes `isResult()` as 
boilerplate, every call site migrated in this PR stops compiling. A one-line 
comment above `isResult()` would prevent that, for example:
   
   ```java
   // Written out: Lombok does not generate isResult() while the deprecated 
getResult() exists.
   ```
   


-- 
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]

Reply via email to