Addressing cran comments about missing return param for tidy doc

nt-williams · Sep 17, 2024 · d259fec · d259fec
1 parent a13af24
commit d259fec
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION
@@ -0,0 +1,3 @@
+Version: 0.1.0
+Date: 2024-09-16 18:15:56 UTC
+SHA: a13af24a6d88f0423f40359bec32190235306378
diff --git a/R/tidy.R b/R/tidy.R
@@ -7,6 +7,8 @@ generics::tidy
 #' @param x A `crumble` object produced by a call to [crumble::crumble()].
 #' @param ... Unused, included for generic consistency only.
 #'
+#' @return A tidy [tibble::tibble()] summarizing information about the model.
+#'
 #' @example inst/examples/examples.R
 #'
 #' @export

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,3 +1,7 @@
+## Notes
+
+-		Added \value tag to tidy.crumble() documentation
+
 ## Test environments
 
 -   Mac OS, ARM64 (local install), R release

diff --git a/man/tidy.crumble.Rd b/man/tidy.crumble.Rd