mlr-org / mlr3

mlr3: Machine Learning in R - next generation
https://mlr3.mlr-org.com
GNU Lesser General Public License v3.0
948 stars 85 forks source link

document the autotest system #1143

Closed berndbischl closed 2 months ago

berndbischl commented 2 months ago

doc it in this way: 1) doc the API in the src files 2) for complicated code parts, add block comments 3) either summarize the autotest procedure in the dev wiki, or, as we don't really need redundant text, do a very BRIEF summary in the wiki and simply link to the API docs

be-marc commented 2 months ago

Did you see #1128 ?

berndbischl commented 2 months ago

ok, we now have 2 files. R/mlr_test_helpers.R inst/testthat/autotest.R

in both files mention that the other exists and: add 2 link in the dev wiki under "autotests"

be-marc commented 2 months ago

Done