Add format support to @inherit (#1531)

Fixes #1293

Author: hadley

NEWS.md

@@ -1,5 +1,7 @@
 # roxygen2 (development version)
 
+* `@inherit` can now also inherit from `@format` (#1293). 
+
 * `@describeIn()` gives a more informative warning if you use it with an
   unsupported type (#1490).
 

R/collate.R

@@ -53,7 +53,7 @@ update_collate <- function(base_path) {
 
 generate_collate <- function(base_path) {
   paths <- sort_c(dir(base_path, pattern = "[.][Rr]$", full.names = TRUE))
-  includes <- lapply(paths, find_includes)
+  includes <- lapply(paths, function(x) intersect(find_includes(x), basename(paths)))
   names(includes) <- paths
 
   n <- sum(map_int(includes, length))

R/rd-inherit.R

@@ -109,6 +109,7 @@ topics_process_inherit <- function(topics, env) {
   topics$topo_apply(inherits("author"), inherit_field, "author")
   topics$topo_apply(inherits("source"), inherit_field, "source")
   topics$topo_apply(inherits("note"), inherit_field, "note")
+  topics$topo_apply(inherits("note"), inherit_field, "format")
 
   # First inherit individual sections, then all sections.
   topics$topo_apply(function(x) x$inherits_section_from(), inherit_section)

R/tag-parser.R

@@ -32,7 +32,8 @@ tag_value <- function(x) {
 # Also recorded in tags.yml
 inherit_components <- c(
   "params", "return", "title", "description", "details", "seealso",
-  "sections", "references", "examples", "author", "source", "note"
+  "sections", "references", "examples", "author", "source", "note",
+  "format"
 )
 
 #' @export

inst/roxygen2-tags.yml

@@ -209,7 +209,8 @@
 
     Otherwise, specify individual components to inherit by picking one or
     more of `params`, `return`, `title`, `description`, `details`, `seealso`,
-    `sections`, `references`, `examples`, `author`, `source`, and `note`.
+    `sections`, `references`, `examples`, `author`, `source`, `note`,
+    and `format`.
   template: ' ${1:source} ${2:components}'
   vignette: reuse
   recommend: true

tests/testthat/test-rd-inherit.R

@@ -74,13 +74,7 @@ test_that("no options gives default values", {
     NULL
   ")[[1]]
 
-  expect_equal(
-    block_get_tag_value(block, "inherit")$fields,
-    c(
-      "params", "return", "title", "description", "details", "seealso",
-      "sections", "references", "examples", "author", "source", "note"
-    )
-  )
+  expect_equal(block_get_tag_value(block, "inherit")$fields, inherit_components)
 })
 
 test_that("some options overrides defaults", {
@@ -707,6 +701,7 @@ test_that("can inherit all from single function", {
     #' @author Hadley
     #' @source my mind
     #' @note my note
+    #' @format my format
     #' @examples
     #' x <- 1
     foo <- function(x, y) {}
@@ -722,6 +717,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("format"), "my format")
   expect_equal(out$get_value("note"), "my note")
 })