uros-b opened a new pull request, #58563: URL: https://github.com/apache/spark/pull/58563
### What changes were proposed in this pull request? The public `StateSpec` API documents its `@param` and `@tparam` but omits `@return` on every method. This adds `@return` tags to all nine public methods: - the four `StateSpec.function(...)` factory overloads (companion object) -- "a new `StateSpec` for the `mapWithState` operation"; - the five builder methods on the abstract class (`initialState` x2, `numPartitions`, `partitioner`, `timeout`), which return `this.type` -- "this `StateSpec` (to allow chaining)". Scaladoc only; no code changes. ### Why are the changes needed? It completes the Scaladoc for the public `StateSpec` surface so the generated API docs state what each method returns. The `function` factories return a freshly built `StateSpec`, and the builder methods return the same instance to allow fluent chaining (as in the class example, `StateSpec.function(mappingFunction).numPartitions(10)`); making the return explicit closes a small, pre-existing doc gap. ### Does this PR introduce _any_ user-facing change? No. Scaladoc-only; no API or behavior change. ### How was this patch tested? N/A -- documentation-only change. The `streaming` module compiles cleanly. ### 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]
