-
Notifications
You must be signed in to change notification settings - Fork 5.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
8340785: Update description of PassFailJFrame and samples #21162
Conversation
Re-work the entire description of PassFailJFrame: Add description of what UI elements it provides and how to interact with them. Add anchors for linking to the sections. Use {@snippet} instead of <pre>{@code}</pre> for sample code. Use method references instead of lambdas in samples. Document required jtreg tags to use PassFailJFrame. Rename SampleOldManualTest to ObsoleteManualTest. Provide an overview of Builder methods to configure PassFailJFrame.
👋 Welcome back aivanov! A progress list of the required criteria for merging this PR into |
@aivanov-jdk This change now passes all automated pre-integration checks. ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details. After integration, the commit message for the final commit will be:
You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed. At the time when this comment was updated there had been 48 new commits pushed to the
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details. ➡️ To integrate this PR with the above commit message to the |
@aivanov-jdk The following label will be automatically applied to this pull request:
When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command. |
Webrevs
|
There are still some missing parts, like more details on different kinds of At the same time, the description is close to comprehensive, the javadoc comment for the |
* A framework for manual tests to display test instructions and | ||
* <i>Pass</i> / <i>Fail</i> buttons. The framework automatically | ||
* creates a frame to display the instructions, provides buttons | ||
* to select the test result, handles test timeout. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"and handles"
/integrate |
Going to push as commit 5063494.
Your commit was automatically rebased without conflicts. |
@aivanov-jdk Pushed as commit 5063494. 💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored. |
I re-worked the entire description of
PassFailJFrame
:Add description of what UI elements it provides and how to interact with them.
Add anchors for linking to the sections.
Use
{@snippet}
instead of<pre>{@code}</pre>
for sample code.Use method references instead of lambdas in samples.
Document required jtreg tags to use
PassFailJFrame
.Rename
SampleOldManualTest
toObsoleteManualTest
.Provide an overview of
Builder
methods to configurePassFailJFrame
.As in #21145, the generated javadoc PassFailJFrame.html could be easier to read and review.
The current version of the generated docs contains changes from #21145 and this PR. The PRs can be integrated independently.
Progress
Issue
Reviewers
Reviewing
Using
git
Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/21162/head:pull/21162
$ git checkout pull/21162
Update a local copy of the PR:
$ git checkout pull/21162
$ git pull https://git.openjdk.org/jdk.git pull/21162/head
Using Skara CLI tools
Checkout this PR locally:
$ git pr checkout 21162
View PR using the GUI difftool:
$ git pr show -t 21162
Using diff file
Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/21162.diff
Webrev
Link to Webrev Comment