remove "optimal" option for weight_func()

Author: hfrick

NEWS.md

@@ -11,8 +11,12 @@
 
 * For space-filling designs for $p$ parameters, there is a higher likelihood of finding a space-filling design for `1 < size <= p`. Also, single-point designs now default to a random grid (#363).
 
+## Breaking changes
+
 * The `grid_*()` functions now error instead of warn when provided with the wrong argument to control the grid size. So `grid_space_filling()`, `grid_random()`, `grid_max_entropy()`, and `grid_latin_hypercube()` now error if used with a `levels` argument and `grid_regular()` now errors if used with a `size` argument (#368).
 
+* The `"optimal"` option for the `weight_func()` parameter has been removed since it is choosing the optimal value based on the resubstition error (#370). 
+
 
 # dials 1.3.0
 

R/param_weight_func.R

@@ -29,6 +29,5 @@ values_weight_func <- c(
   "cos",
   "inv",
   "gaussian",
-  "rank",
-  "optimal"
+  "rank"
 )

man/weight_func.Rd

@@ -187,9 +187,9 @@
       print(fun_ish)
     Message
       Qualitative Parameter
-      10 possible values include:
+      9 possible values include:
       'rectangular', 'triangular', 'epanechnikov', 'biweight', 'triweight', 'cos',
-      'inv', 'gaussian', 'rank', and 'optimal'
+      'inv', 'gaussian', and 'rank'
 
 ---