Addresses CRAN comments

.Rbuildignore

@@ -10,3 +10,4 @@
 ^docs$
 ^pkgdown$
 ^cran-comments\.md$
+^CRAN-SUBMISSION$

CRAN-SUBMISSION

@@ -0,0 +1,3 @@
+Version: 0.1.0
+Date: 2024-04-23 22:39:05 UTC
+SHA: e13ed96bef73555af4db093ed12609bf359873d6

DESCRIPTION

@@ -6,8 +6,8 @@ Authors@R: c(
   person(given = "Posit Software, PBC", role = c("cph", "fnd"))
   )
 Description: Enables user interactivity with large-language models ('LLM') inside
-    the 'RStudio' integrated development environment ('IDE'). The user can
-    interact with the model using the 'Shiny' app included in this package, or
+    the 'RStudio' integrated development environment (IDE). The user can
+    interact with the model using the 'shiny' app included in this package, or
     directly in the 'R' console. It comes with back-ends for 'OpenAI', 'GitHub'
     'Copilot', and 'LlamaGPT'. 
 URL: https://github.com/mlverse/chattr,

R/ch-history.R

@@ -2,6 +2,7 @@
 #' @param x An list object that contains chat history. Use this argument to
 #' override the current history.
 #' @keywords internal
+#' @returns A list object with the current chat history
 #' @export
 ch_history <- function(x = NULL) {
   if (!is.null(x)) {

R/ch-submit.R

@@ -22,6 +22,7 @@
 #' `chattr_defaults()` function, and set the provider. The `provider` value
 #' is what creates the R class name. It will pre-pend `cl_` to the class name.
 #' See the examples for more clarity.
+#' @returns The output from the model currently in use.
 #' @examples
 #' \dontrun{
 #' library(chattr)