junit5 icon indicating copy to clipboard operation
junit5 copied to clipboard

ConfigurationParameters values does not appear to be comprehensively documented

Open xenoterracide opened this issue 4 years ago • 10 comments

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?

xenoterracide avatar Jan 05 '21 23:01 xenoterracide

Related to #1803

sormuras avatar Jan 06 '21 03:01 sormuras

They should all be documented here: https://junit.org/junit5/docs/current/api/org.junit.jupiter.engine/org/junit/jupiter/engine/Constants.html

marcphilipp avatar Jan 07 '21 14:01 marcphilipp

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

xenoterracide avatar Jan 07 '21 15:01 xenoterracide

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 avatar May 13 '21 12:05 marcphilipp

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

marcphilipp avatar May 13 '21 12:05 marcphilipp

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 ;)

xenoterracide avatar May 13 '21 14:05 xenoterracide

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.

marcphilipp avatar May 14 '21 10:05 marcphilipp

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[bot] avatar Aug 15 '22 21:08 stale[bot]

I would assume this is still needed

On Mon, Aug 15, 2022, 5:18 PM stale[bot] @.***> wrote:

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.

— Reply to this email directly, view it on GitHub https://github.com/junit-team/junit5/issues/2516#issuecomment-1215836004, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAABLDPQHVXGVLGLDXLSIYLVZKXZ3ANCNFSM4VWTCZXQ . You are receiving this because you authored the thread.Message ID: @.***>

xenoterracide avatar Aug 15 '22 21:08 xenoterracide

All constants can also be viewed in the Javadoc:

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

sbrannen avatar Apr 19 '23 15:04 sbrannen