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.

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

ConfigurationParameters values does not appear to be comprehensively documented #2516

Closed
xenoterracide opened this issue Jan 5, 2021 · 11 comments

Comments

@xenoterracide
Copy link

I searched https://junit.org/junit5/docs/current/user-guide/#running-tests-config-params and the surefire plugin (which seems to have some different values from what I found in the user-guide. Could you please add a comprehensive list to this section of documentation?

@sormuras
Copy link
Member

sormuras commented Jan 6, 2021

Related to #1803

@marcphilipp
Copy link
Member

@xenoterracide
Copy link
Author

could a link to that be added to the ConfigurationParameters javadoc? because that's where I looked, and found via google

@marcphilipp
Copy link
Member

The problem is that ConfigurationParameters doesn't depend on Jupiter. Thus adding a link the Constants class is not possible AFAIK. We could add a section to the user guide that lists all configuration parameters and link there, though. Thoughts?

@marcphilipp
Copy link
Member

Tentatively slated for 5.8 M2 solely for the purpose of team discussion.

@xenoterracide
Copy link
Author

up to you in my opinion, you could also do a normal web link. I'm fine with whatever, I just want it to be easier to find ;)

@marcphilipp
Copy link
Member

Team decision: Add a table containing all config parameters (Platform, Jupiter, Vintage (?)) in the user guide and link to it from the class-level Javadoc of ConfigurationParameters.

@sormuras sormuras modified the milestones: 5.8 M2, 5.8 RC1 May 21, 2021
@marcphilipp marcphilipp removed this from the 5.8 RC1 milestone Aug 15, 2021
@stale
Copy link

stale bot commented Aug 15, 2022

This issue has been automatically marked as stale because it has not had recent activity. Given the limited bandwidth of the team, it will be automatically closed if no further activity occurs. Thank you for your contribution.

@stale stale bot added the status: stale label Aug 15, 2022
@xenoterracide
Copy link
Author

xenoterracide commented Aug 15, 2022 via email

@stale stale bot removed the status: stale label Aug 15, 2022
@sbrannen
Copy link
Member

All constants can also be viewed in the Javadoc:

https://junit.org/junit5/docs/current/api/constant-values.html

@marcphilipp
Copy link
Member

Closing in favor of #4330 which has more information

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

No branches or pull requests

4 participants