Drop pkg:: prefix for superclasses in the same package (#1816)

Fixes #1567

Author: hadley

NEWS.md

@@ -3,6 +3,7 @@
 * `@examplesIf` now warns when there is no example code after the condition (#1695).
 * `tag_words_line()` is deprecated in favour of `tag_words()`, which now checks for single-line content by default. Use `tag_words(x, multiline = TRUE)` or `tag_value(x, multiline = TRUE)` if your tag legitimately spans multiple lines.
 * R6 improvements:
+  * The "Super classes" section now omits the `pkg::` prefix for parent classes from the same package, making the inheritance chain easier to read (#1567).
   * R6 classes with only active bindings and `cloneable = FALSE` no longer error during documentation (#1610).
   * `initialize()` method parameters now automatically inherit documentation from `@field` tags with the same name, reducing the need to duplicate descriptions. Explicit `@param` tags still take precedence (#1004).
 * New `needs_roxygenize()` provides a lightweight check that man pages are up-to-date by comparing modification times of `.Rd` files with their source files (#1411).

R/rd-r6-super.R

@@ -27,11 +27,17 @@ format.rd_r6_super <- function(x, ...) {
 
   title <- if (length(cls) > 1) "Super classes" else "Super class"
 
-  path <- ifelse(
-    ht,
-    sprintf("\\code{\\link[%s:%s]{%s::%s}}", pkgs, cls, pkgs, cls),
-    sprintf("\\code{%s::%s}", pkgs, cls)
-  )
+  self_pkg <- roxy_meta_get("current_package") %||% ""
+  same_pkg <- pkgs == self_pkg
+
+  label <- ifelse(same_pkg, cls, paste0(pkgs, "::", cls))
+  path <- map_chr(seq_along(cls), function(i) {
+    if (ht[[i]]) {
+      rd_link(pkgs[[i]], cls[[i]], label[[i]], code = TRUE)
+    } else {
+      paste0("\\code{", label[[i]], "}")
+    }
+  })
   me <- sprintf("\\code{%s}", x$class)
 
   c(

tests/testthat/_snaps/rd-r6-super.md

@@ -7,3 +7,12 @@
       \code{mypkg::Parent} -> \code{Child}
       }
 
+# format.rd_r6_super omits pkg:: for same-package classes
+
+    Code
+      cat(format(supers), sep = "\n")
+    Output
+      \section{Super classes}{
+      \code{otherpkg::GrandParent} -> \code{Parent} -> \code{Child}
+      }
+

tests/testthat/_snaps/rd-r6.md

@@ -217,7 +217,7 @@
       A method 4.
       }
       \section{Super class}{
-      \code{testR6::A} -> \code{B}
+      \code{A} -> \code{B}
       }
       \section{Public fields}{
       \if{html}{\out{<div class="r6-fields">}}
@@ -323,7 +323,7 @@
       C method 5.
       }
       \section{Super classes}{
-      \code{testR6::A} -> \code{testR6::B} -> \code{C}
+      \code{A} -> \code{B} -> \code{C}
       }
       \section{Public fields}{
       \if{html}{\out{<div class="r6-fields">}}

tests/testthat/test-rd-r6-super.R

@@ -33,6 +33,17 @@ test_that("format.rd_r6_super with one superclass", {
   expect_snapshot(cat(format(supers), sep = "\n"))
 })
 
+test_that("format.rd_r6_super omits pkg:: for same-package classes", {
+  local_roxy_meta_set("current_package", "mypkg")
+  supers <- rd_r6_super(
+    "Child",
+    package = c("mypkg", "otherpkg"),
+    classname = c("Parent", "GrandParent"),
+    has_topic = c(FALSE, FALSE)
+  )
+  expect_snapshot(cat(format(supers), sep = "\n"))
+})
+
 test_that("format.rd_r6_super returns nothing when empty", {
   expect_null(format(rd_r6_super("Foo")))
 })