adding @return tag

insightsengineering · Jan 12, 2024 · 18d510d · 18d510d
1 parent 3e071ad
commit 18d510d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/R/join_keys-utils.R b/R/join_keys-utils.R
@@ -72,7 +72,7 @@ assert_parent_child <- function(x) {
 
 #' Helper function to ensuring compatibility between two sets of keys
 #'
-#' return TRUE if compatible, throw error otherwise
+#' @return Return `TRUE` if compatible, throw error otherwise
 #' @keywords internal
 assert_compatible_keys2 <- function(x, y) {
   # Helper to flatten join_keys / join_key_set

diff --git a/man/assert_compatible_keys2.Rd b/man/assert_compatible_keys2.Rd