You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "uros-b (via GitHub)" <gi...@apache.org> on 2026/09/07 08:29:21 UTC
[PR] [SPARK-59291][STREAMING] Add @return tags to the public StateSpec methods [spark]
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-59291][STREAMING] Add @return tags to the public StateSpec methods [spark]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on PR #58563:
URL: https://github.com/apache/spark/pull/58563#issuecomment-5636503170
The doc changes look correct to me: all four `function` factories build a new `StateSpecImpl`, and all five builder methods return `this`.
Could you retitle the PR before merge, e.g. `Add return tags to the public StateSpec methods`? `dev/merge_spark_pr.py` strips `@` from the PR body but not from the title, so `@return` would end up in the master commit subject and keep pinging the GitHub user `return`.
Nit: the 2nd and 4th `function` overloads are also missing `@tparam KeyType`. It would be nice to add those here too.
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-59291][STREAMING] Add return tags to the public StateSpec methods [spark]
Posted by "uros-b (via GitHub)" <gi...@apache.org>.
uros-b commented on PR #58563:
URL: https://github.com/apache/spark/pull/58563#issuecomment-5644511545
My apologies to the innocent GitHub user who I tagged here! That's a super cool username, but I couldn't imagine the inbox...ðŸ˜
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-59291][STREAMING] Add @return tags to the public StateSpec methods [spark]
Posted by "uros-b (via GitHub)" <gi...@apache.org>.
uros-b commented on PR #58563:
URL: https://github.com/apache/spark/pull/58563#issuecomment-5633260686
soft ping here ^^
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-59291][STREAMING] Add return tags to the public StateSpec methods [spark]
Posted by "uros-b (via GitHub)" <gi...@apache.org>.
uros-b commented on PR #58563:
URL: https://github.com/apache/spark/pull/58563#issuecomment-5657128310
Thank you @dongjoon-hyun!
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-59291][STREAMING] Add @return tags to the public StateSpec methods [spark]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on PR #58563:
URL: https://github.com/apache/spark/pull/58563#issuecomment-5636457520
Hi, @uros-b . Please be careful in GitHub. Your PR is giving lots of noise to someone who has the valid GitHub Account name like the following. 😄
<img width="552" height="61" alt="Screenshot 2026-09-11 at 08 02 42" src="https://github.com/user-attachments/assets/4ce63e42-b0cc-4a99-9c7a-6c9c8b3c19e8" />
<img width="709" height="671" alt="Screenshot 2026-09-11 at 08 04 10" src="https://github.com/user-attachments/assets/32da7f8f-ab55-4595-97d3-98f3698b9d83" />
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-59291][STREAMING] Add return tags to the public StateSpec methods [spark]
Posted by "uros-b (via GitHub)" <gi...@apache.org>.
uros-b commented on PR #58563:
URL: https://github.com/apache/spark/pull/58563#issuecomment-5657125831
**Merge Summary:**
- merged into master https://github.com/apache/spark/commit/2dcbadb3aa878f8100b3574b7cef26b7d16e37f3
- merged into branch-4.x https://github.com/apache/spark/commit/f29cd3073d17ce853320d884398d73f69b26e9b1
*Posted by `merge_spark_pr.py`*
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-59291][STREAMING] Add return tags to the public StateSpec methods [spark]
Posted by "uros-b (via GitHub)" <gi...@apache.org>.
uros-b closed pull request #58563: [SPARK-59291][STREAMING] Add return tags to the public StateSpec methods
URL: https://github.com/apache/spark/pull/58563
--
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: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org