Open
Description
When using the returns tag in the documentation of an R6 method, the text is rendered in the "Value" section of the class description (and not the method description). returns is indeed not listed in r6_tags:
topic_add_r6_methods <- function(rd, block, env) {
r6data <- block_get_tag_value(block, ".r6data")
self <- r6data$self
methods <- self[self$type == "method", ]
methods <- methods[order(methods$file, methods$line), ]
methods$tags <- replicate(nrow(methods), list(), simplify = FALSE)
r6_tags <- c("description", "details", "param", "return", "examples") # <<<<<<<<<<<<
(...)
Is this something that could be added easily? I prefer to use returns by default in all of my code "because it reads more naturally" (footnote 10 in section 16.4 of R Packages).
Metadata
Metadata
Assignees
Labels
No labels