Polish contribution

See #3693

(cherry picked from commit 2a5c6b2)

Author: sbrannen

documentation/src/docs/asciidoc/release-notes/release-notes-5.10.3.adoc

@@ -15,7 +15,7 @@ on GitHub.
 
 ==== Bug Fixes
 
-* The `junit-platform-suite-engine` now includes configuration provided by
+* The `junit-platform-suite-engine` now includes configuration provided via
   `@ConfigurationParameter` when selecting tests by `UniqueId`.
 
 ==== Deprecations and Breaking Changes

junit-platform-suite-commons/src/main/java/org/junit/platform/suite/commons/SuiteLauncherDiscoveryRequestBuilder.java

@@ -97,7 +97,8 @@
  *   )
  *   .configurationParameter("key", "value")
  *   .enableImplicitConfigurationParameters(true)
- *   .suite(File.class)
+ *   .applyConfigurationParametersFromSuite(MySuite.class)
+ *   .applySelectorsAndFiltersFromSuite(MySuite.class)
  *   .build();
  * }</pre>
  *
@@ -254,14 +255,15 @@ public SuiteLauncherDiscoveryRequestBuilder enableImplicitConfigurationParameter
 	}
 
 	/**
-	 * Apply a suites annotation based configuration, selectors and filters to this builder.
+	 * Apply a suite's annotation-based configuration, selectors, and filters to
+	 * this builder.
 	 *
-	 * @param suiteClass the class to apply the annotations from;
-	 * never {@code null}
+	 * @param suiteClass the class to apply the annotations from; never {@code null}
 	 * @return this builder for method chaining
-	 * @since 1.11
 	 * @see org.junit.platform.suite.api.Suite
-	 * @deprecated use {@link #applyConfigurationParametersFromSuite} and/or {@link #applySelectorsAndFiltersFromSuite} instead.
+	 * @deprecated as of JUnit Platform 1.11 in favor of
+	 * {@link #applyConfigurationParametersFromSuite} and
+	 * {@link #applySelectorsAndFiltersFromSuite}
 	 */
 	@Deprecated
 	public SuiteLauncherDiscoveryRequestBuilder suite(Class<?> suiteClass) {
@@ -272,15 +274,16 @@ public SuiteLauncherDiscoveryRequestBuilder suite(Class<?> suiteClass) {
 	}
 
 	/**
-	 * Apply a suites annotation based configuration to this builder.
-	 * <p>
-	 * This will apply the configuration from:
+	 * Apply a suite's annotation-based configuration to this builder.
+	 *
+	 * <p>This will apply the configuration from the following annotations.
 	 * <ul>
 	 *   <li>{@link ConfigurationParameter}</li>
 	 *   <li>{@link DisableParentConfigurationParameters}</li>
 	 * </ul>
 	 *
-	 * @param suiteClass the class to apply the configuration annotations from; never {@code null}
+	 * @param suiteClass the class to apply the configuration annotations from;
+	 * never {@code null}
 	 * @return this builder for method chaining
 	 * @since 1.11
 	 * @see org.junit.platform.suite.api.Suite
@@ -298,9 +301,10 @@ public SuiteLauncherDiscoveryRequestBuilder applyConfigurationParametersFromSuit
 	}
 
 	/**
-	 * Apply a suites annotation based discovery selectors and filters to this builder.
-	 * <p>
-	 * This will apply the configuration from:
+	 * Apply a suite's annotation-based discovery selectors and filters to this
+	 * builder.
+	 *
+	 * <p>This will apply the configuration from the following annotations.
 	 * <ul>
 	 *   <li>{@link ExcludeClassNamePatterns}</li>
 	 *   <li>{@link ExcludeEngines}</li>
@@ -320,7 +324,8 @@ public SuiteLauncherDiscoveryRequestBuilder applyConfigurationParametersFromSuit
 	 *   <li>{@link SelectPackages}</li>
 	 * </ul>
 	 *
-	 * @param suiteClass the class to apply the discovery selectors and filter annotations from; never {@code null}
+	 * @param suiteClass the class to apply the discovery selectors and filter
+	 * annotations from; never {@code null}
 	 * @return this builder for method chaining
 	 * @since 1.11
 	 * @see org.junit.platform.suite.api.Suite

platform-tests/src/test/java/org/junit/platform/suite/engine/SuiteEngineTests.java

@@ -275,7 +275,7 @@ void selectMethodsInTestPlanByUniqueId() {
 	}
 
 	@Test
-	void selectConfigurationSensitiveMethodsInTestPlanByUnique() {
+	void selectConfigurationSensitiveMethodsInTestPlanByUniqueId() {
 		// @formatter:off
 		var uniqueId1 = UniqueId.forEngine(ENGINE_ID)
 				.append(SuiteTestDescriptor.SEGMENT_TYPE, ConfigurationSuite.class.getName())

platform-tests/src/test/java/org/junit/platform/suite/engine/testcases/ConfigurationSensitiveTestCase.java

@@ -17,7 +17,7 @@
 import org.junit.jupiter.api.TestMethodOrder;
 
 /**
- * @since 1.10.2
+ * @since 1.11
  */
 @TestMethodOrder(MethodName.class)
 public class ConfigurationSensitiveTestCase {
@@ -31,6 +31,8 @@ void test1() {
 
 	@Test
 	void test2() {
+		// This will fail unless the test instance lifecycle is set to per_class,
+		// which is configured via @ConfigurationParameter in ConfigurationSuite.
 		assertTrue(shared);
 	}