Skip to content

Commit 6f2dacd

Browse files
committed
Update Suite annotation to match
1 parent 8546b97 commit 6f2dacd

File tree

1 file changed

+6
-4
lines changed
  • junit-platform-suite-api/src/main/java/org/junit/platform/suite/api

1 file changed

+6
-4
lines changed

junit-platform-suite-api/src/main/java/org/junit/platform/suite/api/Suite.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,12 @@
4545
* configuration parameters are taken into account.
4646
*
4747
* <p>Note: Tests in a suite are executed in addition to the tests executed by every
48-
* other test engine, so it is possible to for the same test to be executed twice. A
49-
* common solution is to use a naming pattern. Name all suites {@code *Suite} and all
50-
* tests {@code *Test} and configure your build tool to only include the former.
51-
* Alternatively, consider using tags to select specific groups of tests.
48+
* other test engine. This can result in the same tests being executed twice. This can be
49+
* prevented by configuring your build tool to only include the
50+
* {@value org.junit.platform.suite.engine.SuiteEngineDescriptor#ENGINE_ID} engine. Or by
51+
* using a naming pattern. For example name all suites {@code *Suite} and all tests
52+
* {@code *Test} and configure your build tool to only include the former. Alternatively,
53+
* consider using tags to select specific groups of tests.
5254
*
5355
* @since 1.8
5456
* @see Select

0 commit comments

Comments
 (0)