Add support for inheriting 'note' fields (#1219)

Fixes #1218
r-lib · Mar 30, 2022 · 623c473 · 623c473
1 parent 03e6913
commit 623c473
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 2 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,7 @@
 # roxygen2 (development version)
 
+* Add support for inheriting 'note' fields via `@inherit pkg::fun note` (@pat-s, #1218)
+
 * Problems with the first tag in each block are now reported with the
   correct line number (#1235).
 

diff --git a/R/rd-inherit.R b/R/rd-inherit.R
@@ -108,6 +108,7 @@ topics_process_inherit <- function(topics, env) {
   topics$topo_apply(inherits("examples"), inherit_field, "examples")
   topics$topo_apply(inherits("author"), inherit_field, "author")
   topics$topo_apply(inherits("source"), inherit_field, "source")
+  topics$topo_apply(inherits("note"), inherit_field, "note")
 
   # First inherit individual sections, then all sections.
   topics$topo_apply(function(x) x$inherits_section_from(), inherit_section)

diff --git a/R/tag-parser.R b/R/tag-parser.R
@@ -40,7 +40,7 @@ tag_inherit <- function(x) {
 
     # Also recorded in `rd.Rmd`
     all <- c("params", "return", "title", "description", "details", "seealso",
-      "sections", "references", "examples", "author", "source")
+      "sections", "references", "examples", "author", "source", "note")
     if (length(fields) == 0) {
       fields <- all
     } else {

diff --git a/tests/testthat/test-rd-inherit.R b/tests/testthat/test-rd-inherit.R
@@ -48,7 +48,7 @@ test_that("no options gives default values", {
     block_get_tag_value(block, "inherit")$fields,
     c(
       "params", "return", "title", "description", "details", "seealso",
-      "sections", "references", "examples", "author", "source"
+      "sections", "references", "examples", "author", "source", "note"
     )
   )
 })
@@ -575,6 +575,7 @@ test_that("can inherit all from single function", {
     #' @param y y
     #' @author Hadley
     #' @source my mind
+    #' @note my note
     #' @examples
     #' x <- 1
     foo <- function(x, y) {}
@@ -590,6 +591,7 @@ test_that("can inherit all from single function", {
   expect_equal(out$get_value("examples"), rd("x <- 1"))
   expect_equal(out$get_value("author"), "Hadley")
   expect_equal(out$get_value("source"), "my mind")
+  expect_equal(out$get_value("note"), "my note")
 })