Check that object has a name

Fixes #1490
r-lib · Nov 15, 2023 · 968b5b8 · 968b5b8
1 parent a4afa00
commit 968b5b8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,8 @@
 # roxygen2 (development version)
 
+* `@describeIn()` gives a more informative warning if you use it with an
+  unsupported type (#1490).
+
 * A friendlier error is thrown when attempting to import non-existing
   functions with `@importFrom` (#1409, @MichaelChirico).
 * authors in `DESCRIPTION` can now have multiple email addresses (@jmbarbone, #1487).

diff --git a/R/rd-describe-in.R b/R/rd-describe-in.R
@@ -21,6 +21,10 @@ topic_add_describe_in <- function(topic, block, env) {
     warn_roxy_tag(tag, "can not be used with @rdname")
     return()
   }
+  if (is.null(object_name(block$object))) {
+    warn_roxy_tag(tag, "not supported with this object type")
+    return()
+  }
 
   dest <- find_object(tag$val$name, env)
   metadata <- build_minidesc_metadata(block$object, dest)