Skip to content

Commit d579ba4

Browse files
authored
Merge pull request #890 from mlr-org/docs-valid
better docs for internal valid data
2 parents c2e3481 + 81e7284 commit d579ba4

4 files changed

Lines changed: 9 additions & 3 deletions

File tree

R/PipeOp.R

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,9 @@
198198
#' of the class, the id, the `$state`, and the `$param_set$values`. The last point is particularly important: changing the `$param_set$values` should
199199
#' *not* change the return value of `private$.additional_phash_input()`.
200200
#'
201+
#' When you are implementing a `PipeOp` that operates a task (and is not a [`PipeOpTaskPreproc`]), you also need to handle the
202+
#' `$internal_valid_task` field of the input task, if there is one.
203+
#'
201204
#' @examples
202205
#' # example (bogus) PipeOp that returns the sum of two numbers during $train()
203206
#' # as well as a letter of the alphabet corresponding to that sum during $predict().

man/PipeOp.Rd

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mlr_pipeops_adas.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mlr_pipeops_nmf.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)