fix: pkg_doc_obj

Author: WetRobot

DESCRIPTION

@@ -22,4 +22,4 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3

NEWS.md

@@ -1,5 +1,14 @@
 <!-- generated by R package codedoc; do not modify! -->
 
+## News for version 0.10.5
+
+### codedoc::pkg_doc_obj
+
+Improved inference of object name to use in generated documentation.
+E.g. `regex = "\\Qmypkg::[.myclass\\E"` now reliably appears in docs
+as "mypkg::[.myclass".
+
+
 ## News for version 0.10.4
 
 ### codedoc::pkg_doc_fun

R/pkg_doc.R

@@ -143,7 +143,7 @@ pkg_doc_obj_regex_set__ <- function(regex, type) {
   return(out)
 }
 
-pkg_doc_obj_section_heads__ <- function(regex, has_rdname) {
+pkg_doc_obj_section_heads__ <- function(obj_nm, has_rdname) {
   out <- list(
     param = NULL,
     descr = "@details",
@@ -155,16 +155,16 @@ pkg_doc_obj_section_heads__ <- function(regex, has_rdname) {
       param = NULL,
       descr = c(
         "@section Functions:",
-        paste0("**", regex, "**")
+        paste0("**", obj_nm, "**")
       ),
       return = c(
         "@return",
-        paste0("**", regex, "**")
+        paste0("**", obj_nm, "**")
       ),
       examples = c(
         "@examples",
         "",
-        paste0("# ", regex)
+        paste0("# ", obj_nm)
       )
     )
   }
@@ -261,25 +261,32 @@ pkg_doc_obj <- function(
   )
   grepl_arg_list[["x"]] <- df[["key"]]
   section_heads <- local({
-    # proper name in section. instead of showing e.g.
-    # regex = "\\Qmypkg::[.myclass\\E" in docs, we want to show
-    # "mypkg::[.myclass". so we figure out the name of the package and the
-    # object.
+    # instead of showing e.g.
+    # "\\Qmypkg::[.myclass\\E" in docs, we want to show
+    # "mypkg::[.myclass". we look for an exact match in keys or if that fails
+    # try to clean up the regex.
+    # @codedoc_comment_block news("codedoc::pkg_doc_obj", "2025-10-06", "0.10.5")
+    # Improved inference of object name to use in generated documentation.
+    # E.g. `regex = "\\Qmypkg::[.myclass\\E"` now reliably appears in docs
+    # as "mypkg::[.myclass".
+    # @codedoc_comment_block news("codedoc::pkg_doc_obj", "2025-10-06", "0.10.5")
     section_gal <- grepl_arg_list
     section_gal[["pattern"]] <- sprintf(
-      "((^)|[(\"])%s(($)|[\")])",
+      "(?<=^|\\\")%s(?=$|\\\")",
       regex
     )
-    keys <- df[["key"]][
-      df[["key"]] == section_gal[["pattern"]] |
-        do.call(grepl, section_gal)
-    ]
-    pkg_obj_nm_pairs <- unique(gsub("(^.*[(\"])|([)\"].*$)", "", keys))
-    if (length(pkg_obj_nm_pairs) == 1) {
-      regex <- pkg_obj_nm_pairs
+    obj_nm_set <- setdiff(do.call(regex_extract_first__, section_gal), NA)
+    if (length(obj_nm_set) == 1) {
+      obj_nm <- obj_nm_set
+    } else {
+      obj_nm <- gsub(
+        "(\\\\Q|\\\\E|\\\\)",
+        "",
+        regex
+      )
     }
     pkg_doc_obj_section_heads__(
-      regex = regex,
+      obj_nm = obj_nm,
       has_rdname = !is.null(rdname)
     )
   })
@@ -361,10 +368,10 @@ pkg_doc_fun <- function(
   rdname = NULL,
   text_file_paths = NULL
 ) {
-  # @codedoc_comment_block codedoc::pkg_doc_obj
+  # @codedoc_comment_block codedoc::pkg_doc_fun
   # Document a function in an R package. Wrapper for
-  # `codedoc::pkg_doc_fun` .
-  # @codedoc_comment_block codedoc::pkg_doc_obj
+  # `codedoc::pkg_doc_obj` .
+  # @codedoc_comment_block codedoc::pkg_doc_fun
   # @codedoc_comment_block news("codedoc::pkg_doc_fun", "2025-03-10", "0.6.0")
   # New fun `codedoc::pkg_doc_fun`.
   # @codedoc_comment_block news("codedoc::pkg_doc_fun", "2025-03-10", "0.6.0")

R/utils.R

@@ -1,17 +1,16 @@
-
-
-
-
-
-string_extract_first <- function(x, pattern, ...) {
-  m <- regexpr(text = x, pattern = pattern, ...)
-  regmatches(x = x, m = m)
-}
-string_extract_all <- function(x, pattern, ...) {
-  m <- gregexpr(text = x, pattern = pattern, ...)
-  regmatches(x = x, m = m)
+regex_extract_first__ <- function(x, pattern, perl = TRUE, ...) {
+  m <- regexpr(pattern = pattern, text = x, perl = perl, ...)
+  out <- rep(NA_character_, length(x))
+  has_match <- !m %in% c(-1L, NA_integer_)
+  out[has_match] <- regmatches(x = x, m = m)
+  return(out)
 }
 
+regex_extract_all__ <- function(x, pattern, perl = TRUE, ...) {
+  m <- gregexpr(text = x, pattern = pattern, perl = TRUE, ...)
+  out <- regmatches(x = x, m = m)
+  return(out)
+}
 
 string_interpolation_regex <- function() {
   # @codedoc_comment_block string_interpolation_regex
@@ -37,7 +36,7 @@ string_interpolation <- function(x, env, debug_data) {
   #
   # @codedoc_comment_block codedoc:::string_interpolation
   ip_re <- string_interpolation_regex()
-  ip_exprs <- unique(unlist(string_extract_all(x = x, pattern = ip_re)))
+  ip_exprs <- unique(unlist(regex_extract_all__(x = x, pattern = ip_re)))
   if (length(ip_exprs) == 0L) {
     return(x)
   }

man/codedoc-package.Rd

@@ -17,7 +17,7 @@ testthat::test_that("regexes and section heads are in harmony", {
 
   for (has_rdname in c(TRUE, FALSE)) {
     section_heads <- pkg_doc_obj_section_heads__(
-      regex = "mypkg::myfun",
+      obj_nm = "mypkg::myfun",
       has_rdname = TRUE
     )
     regexes <- pkg_doc_obj_regex_set__(