man and tests: fix docs and test

mlr-org · Nov 15, 2024 · 86f2e28 · 86f2e28
1 parent a79d863
commit 86f2e28
Show file tree

Hide file tree

Showing 49 changed files with 786 additions and 333 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -102,7 +102,6 @@ Collate:
     'ResultAssignerSurrogate.R'
     'Surrogate.R'
     'SurrogateLearner.R'
-    'SurrogateLearnerAsync.R'
     'SurrogateLearnerCollection.R'
     'TunerADBO.R'
     'TunerAsyncMbo.R'

diff --git a/NAMESPACE b/NAMESPACE
@@ -27,7 +27,6 @@ export(ResultAssignerArchive)
 export(ResultAssignerSurrogate)
 export(Surrogate)
 export(SurrogateLearner)
-export(SurrogateLearnerAsync)
 export(SurrogateLearnerCollection)
 export(TunerADBO)
 export(TunerAsyncMbo)

diff --git a/man-roxygen/field_archive_surrogate_is_async.R b/man-roxygen/field_archive_surrogate_is_async.R
@@ -0,0 +1,2 @@
+#' @field archive_is_async (`bool(1)``)\cr
+#'   Whether the [bbotk::Archive] is an asynchronous one.
diff --git a/man-roxygen/field_properties.R b/man-roxygen/field_properties.R
@@ -2,4 +2,4 @@
 #'   Set of properties of the optimizer.
 #'   Must be a subset of [`bbotk_reflections$optimizer_properties`][bbotk::bbotk_reflections].
 #'   MBO in principle is very flexible and by default we assume that the optimizer has all properties.
-#'   When fully initialized, properties are determined based on the `loop_function` and `surrogate`.
+#'   When fully initialized, properties are determined based on the loop, e.g., the `loop_function`, and `surrogate`.
diff --git a/man/AcqFunction.Rd b/man/AcqFunction.Rd
diff --git a/man/AcqOptimizer.Rd b/man/AcqOptimizer.Rd
diff --git a/man/ResultAssigner.Rd b/man/ResultAssigner.Rd
diff --git a/man/Surrogate.Rd b/man/Surrogate.Rd
diff --git a/man/SurrogateLearner.Rd b/man/SurrogateLearner.Rd
diff --git a/man/SurrogateLearnerAsync.Rd b/man/SurrogateLearnerAsync.Rd
diff --git a/man/SurrogateLearnerCollection.Rd b/man/SurrogateLearnerCollection.Rd
diff --git a/man/acqo.Rd b/man/acqo.Rd
diff --git a/man/default_acqfunction.Rd b/man/default_acqfunction.Rd
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		#' @field archive_is_async (`bool(1)``)\cr
		#' Whether the [bbotk::Archive] is an asynchronous one.