Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Document SuiteLauncherDiscoveryRequestBuilder #3695

Closed
Tracked by #3838
sbrannen opened this issue Feb 17, 2024 · 4 comments
Closed
Tracked by #3838

Document SuiteLauncherDiscoveryRequestBuilder #3695

sbrannen opened this issue Feb 17, 2024 · 4 comments
Assignees
@airtyon
Labels
component: Platform theme: documentation theme: suites up-for-grabs
Milestone
5.10.3

Comments

@sbrannen
Copy link
Member

LauncherDiscoveryRequestBuilder is very well documented; however, SuiteLauncherDiscoveryRequestBuilder has zero documentation.

We should therefore introduce Javadoc for SuiteLauncherDiscoveryRequestBuilder and all of its public methods, analogous to the documentation for LauncherDiscoveryRequestBuilder. In fact, most of the work will be copy-and-paste.
@sbrannen sbrannen added this to the 5.11 M2 milestone Feb 17, 2024
@airtyon
Copy link

airtyon commented Feb 17, 2024

May I start working on this one?

@sbrannen sbrannen mentioned this issue Feb 18, 2024
Merged
6 tasks
@sbrannen
Copy link
Member Author

Hi @airtyon,

Thank you very much for volunteering!

However, let's hold off until we know if @mpkorstanje wishes to address it.

See #3694 (comment) for details.

@sbrannen
Copy link
Member Author

Good news, @airtyon, @mpkorstanje has said he's happy to let you take this one.

I've assigned it to you.

So, go for it!

airtyon pushed a commit to airtyon/junit5 that referenced this issue Feb 22, 2024
junit-team#3695 added SuiteLauncherDiscoveryRequestBuilder javadoc
4925ccc
airtyon added a commit to airtyon/junit5 that referenced this issue Feb 22, 2024
@airtyon
junit-team#3695 adapted javadoc for LauncherDiscoveryRequestBuilder
103e629
airtyon added a commit to airtyon/junit5 that referenced this issue Feb 22, 2024
@airtyon
junit-team#3695 adapted javadoc for SuiteLauncherDiscoveryRequestBuilder
0d3b55a
airtyon added a commit to airtyon/junit5 that referenced this issue Feb 22, 2024
@airtyon
junit-team#3695 added javadoc for request and filterStandardClassName…
f66dba6 
…Patterns
airtyon added a commit to airtyon/junit5 that referenced this issue Feb 22, 2024
@airtyon
junit-team#3695 added javadoc for the selectors methods
51c9f99
airtyon added a commit to airtyon/junit5 that referenced this issue Feb 22, 2024
@airtyon
junit-team#3695 added javadoc for filters
c3c34ef
airtyon added a commit to airtyon/junit5 that referenced this issue Feb 22, 2024
@airtyon
junit-team#3695 added javadoc for the configuration parameters
d99a27e
airtyon added a commit to airtyon/junit5 that referenced this issue Feb 22, 2024
@airtyon
junit-team#3695 added javadoc for the suite method
d9c7c9f
airtyon added a commit to airtyon/junit5 that referenced this issue Feb 22, 2024
@airtyon
junit-team#3695 added javadoc for the bilder method
5353be3
airtyon added a commit to airtyon/junit5 that referenced this issue Feb 22, 2024
@airtyon
junit-team#3695 added some return statements to the docs
02cdf43
airtyon added a commit to airtyon/junit5 that referenced this issue Feb 22, 2024
@airtyon
junit-team#3695 formatting
f032f35
airtyon added a commit to airtyon/junit5 that referenced this issue Feb 22, 2024
@airtyon
junit-team#3695 fixing minor typo
26c69d9
@airtyon airtyon mentioned this issue Feb 26, 2024
Closed
6 tasks
@sbrannen sbrannen modified the milestones: 5.11 M2, 5.11 M1 Mar 9, 2024
sbrannen added a commit that referenced this issue Mar 10, 2024
@sbrannen
Polish [Suite]LauncherDiscoveryRequestBuilder
e9f1bcc 
See #3695
See #3702
@sbrannen
Copy link
Member Author

This has been addressed in main in c9e66fc and revised in e9f1bcc.

@marcphilipp marcphilipp modified the milestones: 5.11 M1, 5.10.3 Jun 17, 2024
@marcphilipp marcphilipp mentioned this issue Jun 17, 2024
Closed
8 tasks
marcphilipp pushed a commit that referenced this issue Jun 17, 2024
@sbrannen @marcphilipp
Polish [Suite]LauncherDiscoveryRequestBuilder
235f4d7 
See #3695
See #3702

(cherry picked from commit e9f1bcc)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@airtyon airtyon

Labels
component: Platform theme: documentation theme: suites up-for-grabs
Projects
None yet
Milestone
5.10.3
Development

Successfully merging a pull request may close this issue.

Document SuiteLauncherDiscoveryRequestBuilder airtyon/junit5
3 participants
@sbrannen @marcphilipp @airtyon