address doc confusion #1061

JuliaAI · Oct 10, 2023 · 6e9f223 · 6e9f223
1 parent 72d9820
commit 6e9f223
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/docs/src/adding_models_for_general_use.md b/docs/src/adding_models_for_general_use.md
@@ -155,8 +155,15 @@ function RidgeRegressor(; lambda=0.0)
 end
 ```
 
-*Important.* The clean method must have the property that
-`clean!(clean!(model)) == clean!(model)` for any instance `model`.
+*Important.* Performing `clean!(model)` a second time should not mutate `model`. That is,
+this test should hold:
+
+```julia
+clean!(model)
+clone = deepcopy(model)
+clean!(model)
+@test model == clone
+```
 
 Although not essential, try to avoid `Union` types for model
 fields. For example, a field declaration `features::Vector{Symbol}`