Clarify javadoc ConfigurationProvider

assertj · Jul 27, 2019 · 811be90 · 811be90
1 parent 4c63e19
commit 811be90
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/main/java/org/assertj/core/configuration/ConfigurationProvider.java b/src/main/java/org/assertj/core/configuration/ConfigurationProvider.java
@@ -71,7 +71,9 @@ public Configuration configuration() {
   }
 
   /**
-   * Makes sure that AssertJ loads any registered {@link Configuration}.
+   * Triggers loading any registered {@link Configuration}.
+   * <p>
+   * This method should be called before any user configuration changes to make sure these are not overridden by a registered {@link Configuration} later on.
    */
   public static void loadRegisteredConfiguration() {
     // does nothing but results in loading any registered Configuration as CONFIGURATION_PROVIDER is initialized