Only link to topics that exist (#1820)

Fixes #963

Author: hadley

NEWS.md

@@ -5,6 +5,7 @@
 * 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).
+  * Inherited method links now only link to parent classes that have documentation, avoiding broken links when parent classes are undocumented (#963, #1155).
   * `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).
 * All generated links now use the same code path. This will lead to some minor differences when you re-document, but overall the links will now be more consistent (#1792).

R/rd-r6-methods-inherited.R

@@ -21,24 +21,41 @@ format.rd_r6_inherited <- function(x, ...) {
     "><summary>Inherited methods</summary>"
   )
 
+  # Which parent classes are documented?
+  cls <- unique(x$classname)
+  pkgs <- x$package[match(cls, x$classname)]
+  ht <- map2_lgl(cls, pkgs, has_topic)
+  topic_ok <- ht[match(x$classname, cls)]
+
+  # Build display components for each inherited method
   anchor <- sprintf("method-%s-%s", x$classname, x$name)
-  href <- sprintf("../../%s/html/%s.html#%s", x$package, x$classname, anchor)
-  label <- sprintf("%s::%s$%s()", x$package, x$classname, x$name)
+  self_pkg <- roxy_meta_get("current_package") %||% ""
+  same_pkg <- x$package == self_pkg
+  prefix <- ifelse(same_pkg, "", paste0(x$package, "::"))
+  label <- sprintf("%s%s$%s()", prefix, x$classname, x$name)
 
-  items <- paste0(
-    "<li>",
-    sprintf(
-      '<span class="pkg-link" data-pkg="%s" data-topic="%s" data-id="%s">',
-      x$package,
-      x$classname,
-      x$name
-    ),
-    sprintf("<a href='%s'><code>%s</code></a>", href, label),
-    "</span>",
-    "</li>"
+  # Linked version: clickable reference to parent class docs
+  href <- sprintf("../../%s/html/%s.html#%s", x$package, x$classname, anchor)
+  data_attrs <- paste(
+    sprintf('data-pkg="%s"', x$package),
+    sprintf('data-topic="%s"', x$classname),
+    sprintf('data-id="%s"', x$name)
   )
+  linked <- sprintf(
+    '<span class="pkg-link" %s><a href=\'%s\'><code>%s</code></a></span>',
+    data_attrs,
+    href,
+    label
+  )
+
+  # Plain version: just the method name, no link
+  plain <- sprintf("<code>%s</code>", label)
+  items <- paste0("<li>", ifelse(topic_ok, linked, plain), "</li>")
 
-  rd_if_html(paste(c(details, "<ul>", items, "</ul>", "</details>"), collapse = "\n"))
+  rd_if_html(paste(
+    c(details, "<ul>", items, "</ul>", "</details>"),
+    collapse = "\n"
+  ))
 }
 
 r6_extract_inherited_methods <- function(r6data) {

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

@@ -78,7 +78,7 @@
       }
       \if{html}{\out{<details open><summary>Inherited methods</summary>
       <ul>
-      <li><span class="pkg-link" data-pkg="R_GlobalEnv" data-topic="A" data-id="only_a"><a href='../../R_GlobalEnv/html/A.html#method-A-only_a'><code>R_GlobalEnv::A$only_a()</code></a></span></li>
+      <li><code>R_GlobalEnv::A$only_a()</code></li>
       </ul>
       </details>}}
       \if{html}{\out{<hr>}}

tests/testthat/_snaps/rd-r6-methods-inherited.md

@@ -5,8 +5,8 @@
     Output
       \if{html}{\out{<details open><summary>Inherited methods</summary>
       <ul>
-      <li><span class="pkg-link" data-pkg="pkg" data-topic="A" data-id="foo"><a href='../../pkg/html/A.html#method-A-foo'><code>pkg::A$foo()</code></a></span></li>
-      <li><span class="pkg-link" data-pkg="pkg" data-topic="A" data-id="bar"><a href='../../pkg/html/A.html#method-A-bar'><code>pkg::A$bar()</code></a></span></li>
+      <li><code>pkg::A$foo()</code></li>
+      <li><code>pkg::A$bar()</code></li>
       </ul>
       </details>}}
 

tests/testthat/_snaps/rd-r6.md

@@ -249,8 +249,8 @@
       }
       \if{html}{\out{<details open><summary>Inherited methods</summary>
       <ul>
-      <li><span class="pkg-link" data-pkg="testR6" data-topic="A" data-id="meth2"><a href='../../testR6/html/A.html#method-A-meth2'><code>testR6::A$meth2()</code></a></span></li>
-      <li><span class="pkg-link" data-pkg="testR6" data-topic="A" data-id="meth3"><a href='../../testR6/html/A.html#method-A-meth3'><code>testR6::A$meth3()</code></a></span></li>
+      <li><code>A$meth2()</code></li>
+      <li><code>A$meth3()</code></li>
       </ul>
       </details>}}
       \if{html}{\out{<hr>}}
@@ -365,9 +365,9 @@
       }
       \if{html}{\out{<details open><summary>Inherited methods</summary>
       <ul>
-      <li><span class="pkg-link" data-pkg="testR6" data-topic="A" data-id="meth3"><a href='../../testR6/html/A.html#method-A-meth3'><code>testR6::A$meth3()</code></a></span></li>
-      <li><span class="pkg-link" data-pkg="testR6" data-topic="B" data-id="meth1"><a href='../../testR6/html/B.html#method-B-meth1'><code>testR6::B$meth1()</code></a></span></li>
-      <li><span class="pkg-link" data-pkg="testR6" data-topic="B" data-id="meth4"><a href='../../testR6/html/B.html#method-B-meth4'><code>testR6::B$meth4()</code></a></span></li>
+      <li><code>A$meth3()</code></li>
+      <li><code>B$meth1()</code></li>
+      <li><code>B$meth4()</code></li>
       </ul>
       </details>}}
       \if{html}{\out{<hr>}}