uros-b opened a new pull request, #58096: URL: https://github.com/apache/spark/pull/58096
### What changes were proposed in this pull request? This PR adds missing scaladoc `@param` documentation to the public Structured Streaming progress classes in `sql/api` (`org/apache/spark/sql/streaming/progress.scala`): - `StreamingQueryProgress`: adds `@param sink`. - `SinkProgress`: adds `@param metrics`. - `StateOperatorProgress`: adds `@param` tags for all of its constructor parameters (`operatorName`, `numRowsTotal`, `numRowsUpdated`, `allUpdatesTimeMs`, `numRowsRemoved`, `allRemovalsTimeMs`, `commitTimeMs`, `memoryUsedBytes`, `numRowsDroppedByWatermark`, `numShufflePartitions`, `numStateStoreInstances`, `customMetrics`). This is a documentation-only change; no code is modified. ### Why are the changes needed? These are public, `@Evolving` API classes surfaced through the streaming query listener and `StreamingQueryProgress`. Their scaladoc omitted several `@param` entries, so the generated API docs were incomplete for fields users read when consuming progress events. ### Does this PR introduce _any_ user-facing change? No. Documentation-only change. ### How was this patch tested? No tests are required; the change adds scaladoc only. Each added `@param` name was verified to match a constructor parameter of its class, and each description was checked against how the field is populated (`ProgressReporter`, `statefulOperators`). Changed lines stay within 100 characters and introduce no non-ASCII characters. ### Was this patch authored or co-authored using generative AI tooling? Generated-by: Claude Code (Opus 4.8) -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
