Add comment to ProgressCallback doc

[cdjackson]

ProgressCallback uses an iterator to step through the states, and there's no way to know the current state from the binding. The user is expected to call the next method to step the states, but the iterator is also stepped if update is called before the first call to next.

This doesn't feel very nice to me, and I would have preferred to handle this differently, but I didn't want to break the implementation in case others rely on this. Instead I've just added a note to the doc.

Signed-off-by: Chris Jackson chris@cd-jackson.com

[Copilot]

Pull request overview

This PR adds documentation to clarify a non-intuitive behavior in the ProgressCallback interface where calling update() before next() will automatically advance the internal iterator to the first state.

Changes:

• Added a note to the update() method documentation explaining the iterator advancement behavior
• Reformatted the @throws clause for better readability

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

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

[holgerfriedrich]

LGTM, thanks!