[
https://issues.apache.org/jira/browse/ARROW-6792?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16969593#comment-16969593
]
Neal Richardson commented on ARROW-6792:
----------------------------------------
I took a look at this in the course of writing documentation for ARROW-6340.
Some observations:
* It's all or nothing. If we use the new roxygen at all, we have to update all
of our existing docs. In that PR I added `r6 = FALSE` to the RoxygenNote to
keep the old behavior for now.
* The first disqualifying feature I noticed is the that the new R6 stuff
doesn't like how we documented several classes in the same file. It just
repeats "Super classes" and "Methods" sections down the page. See
https://github.com/r-lib/roxygen2/issues/961.
* Bad crossreferences (reported https://github.com/r-lib/pkgdown/issues/1177)
> [R] Explore roxygen2 R6 class documentation
> -------------------------------------------
>
> Key: ARROW-6792
> URL: https://issues.apache.org/jira/browse/ARROW-6792
> Project: Apache Arrow
> Issue Type: Improvement
> Components: R
> Reporter: Neal Richardson
> Priority: Major
> Fix For: 1.0.0
>
>
> roxygen2 version 7.0 adds support for documenting R6 classes, rather than the
> ad hoc approach we've had to take without it:
> [https://github.com/r-lib/roxygen2/blob/master/vignettes/rd.Rmd#L203]
> Try it out and see how we like it, and consider refactoring the docs to use
> it everywhere.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
