Skip to content

Add comment to ProgressCallback doc #5286

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

Merged
holgerfriedrich merged 1 commit into from
Feb 14, 2026
Merged

Add comment to ProgressCallback doc #5286

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions ...ab.core.thing/src/main/java/org/openhab/core/thing/binding/firmware/ProgressCallback.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,13 @@ public interface ProgressCallback {
* Callback operation to update the percentage progress of the firmware update.
* This method can be used to provide detailed progress information additional to the sequence or even without a
* previous defined sequence.
* <br>
* Note that calling this method before the first call to next() will cause the iterator to be stepped to the first
Copy link

Copilot AI Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase "will cause the iterator to be stepped" should be "will cause the iterator to step" or "will step the iterator" for better readability. The passive voice construction here is awkward.

Suggested change
* Note that calling this method before the first call to next() will cause the iterator to be stepped to the first
* Note that calling this method before the first call to next() will step the iterator to the first

Copilot uses AI. Check for mistakes.
* state!
*
* @param progress the progress between 0 and 100
* @throws IllegalArgumentException if given progress is {@code < 0} or {@code > 100} or if given progress is
* smaller than old
* progress
* smaller than old progress
* @throws IllegalStateException if update is finished
*/
void update(int progress);
Expand Down
Loading