Skip to content

[SPARK-55153][SS][PYTHON][DOC] Add documentation for TwsTester#53802

Closed
fedimser wants to merge 2 commits intoapache:masterfrom
fedimser:dmytro-fedoriaka_data/master
Closed

[SPARK-55153][SS][PYTHON][DOC] Add documentation for TwsTester#53802
fedimser wants to merge 2 commits intoapache:masterfrom
fedimser:dmytro-fedoriaka_data/master

Conversation

@fedimser
Copy link
Contributor

@fedimser fedimser commented Jan 14, 2026

What changes were proposed in this pull request?

Add documentation for TwsTester that was added in #53159 and #53491 .

Why are the changes needed?

So users know about TwsTester and can learn from examples how to use it.

Does this PR introduce any user-facing change?

No.

How was this patch tested?

Built the docs, screenshots below.

Screenshot 2026-02-02 at 5 14 33 PM Screenshot 2026-02-02 at 5 16 17 PM Screenshot 2026-02-02 at 5 16 32 PM

Screenshots for Scala examples:

Screenshot 2026-02-02 at 5 24 56 PM Screenshot 2026-02-02 at 5 25 07 PM

Was this patch authored or co-authored using generative AI tooling?

Generated-by: claude-4.5-opus-high (only used for proofreading).

@github-actions
Copy link

github-actions bot commented Jan 14, 2026

JIRA Issue Information

=== New Feature SPARK-55153 ===
Summary: Add documentation for TwsTester
Assignee: None
Status: Open
Affected: ["4.2"]


This comment was automatically generated by GitHub Actions

@github-actions github-actions bot added the DOCS label Jan 14, 2026
@fedimser fedimser marked this pull request as ready for review January 14, 2026 19:32
@fedimser fedimser changed the title Add documentation for TwsTester [SPARK-54805] Add documentation for TwsTester Jan 14, 2026
@HeartSaVioR
Copy link
Contributor

@fedimser Would you mind filing a separate ticket for this? We want to bind a PR per ticket unless the PR is really minor. Thanks!

@fedimser fedimser changed the title [SPARK-54805] Add documentation for TwsTester [SPARK-55153] Add documentation for TwsTester Jan 23, 2026
@fedimser
Copy link
Contributor Author

@fedimser Would you mind filing a separate ticket for this? We want to bind a PR per ticket unless the PR is really minor. Thanks!

Created SPARK-55153.

@HeartSaVioR HeartSaVioR changed the title [SPARK-55153] Add documentation for TwsTester [SPARK-55153][SS][PYTHON][DOC] Add documentation for TwsTester Jan 31, 2026
@HeartSaVioR
Copy link
Contributor

HeartSaVioR commented Jan 31, 2026

docs directory has a guide to install the library for building website - could you please build the page, and take the part of screenshot for the page so that we ensure the change is rendered properly? You can attach that screenshot into the section of "How was this patch tested?"

Otherwise it looks good to me - I admit I haven't looked at the code line by line since it looks like they were included in Scala/Python PR and I assume you copied properly.

@fedimser
Copy link
Contributor Author

fedimser commented Feb 3, 2026

@HeartSaVioR, I added screenshots.
As for code, it's not exactly copied from tests, I did some small adjustments. But then I copy-pasted these snippets back into test and checked that the tests pass.

Copy link
Contributor

@HeartSaVioR HeartSaVioR left a comment

Choose a reason for hiding this comment

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

+1 pending CI

I'll merge this "after" merging the PR #53758

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants