Prototype for R6 Roxygen #399
Conversation
Codecov Report
@@ Coverage Diff @@
## master #399 +/- ##
=======================================
Coverage 91.69% 91.69%
=======================================
Files 71 71
Lines 1783 1783
=======================================
Hits 1635 1635
Misses 148 148
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Looks not bad! And it seems the changes are not so big.
Unrelated to the changes of this PR, there is a linking issue in the Description section.
Also the "Method" section has a subsection which can be toggled interactively - to reveal the inherited methods. Nice tweak of RStudio.
|
This is not really converted to the new documentation approach in roxygen2 v7. Have you read https://roxygen2.r-lib.org/articles/rd.html#r6 ? |
|
Thanks for the link I havent seen that documentation. I have worked off the inital issue for R6 support in roxygen (r-lib/roxygen2#922) but since there is actual documentation, I will gladly take another look at it. |
|
the new commit should actually document this using the new R6 syntax. sorry for my misunderstanding. I documented the parameters of $new by itself in this file but they would usually documented as inherited parameters from Learner. |
|
Can you give a quick summary on the current status? |
|
@mboecker is still working on it. |
|
Superseded by #439. |
5 participants
As we discussed @jakob-r I tried to convert our mlr3 docs to the R6 Roxygen docs. I'm not sure if "@Usage NULL" should still be needed? I included it because otherwise the usage section would just say "LearnerClassif".