From 2423226537216ee5afb520cadeb8abc6e0110d20 Mon Sep 17 00:00:00 2001
From: Edgar Ruiz <edgararuiz@gmail.com>
Date: Thu, 25 Apr 2024 13:29:40 -0500
Subject: [PATCH] Addresses CRAN comments

---
 .Rbuildignore     | 1 +
 CRAN-SUBMISSION   | 3 +++
 DESCRIPTION       | 4 ++--
 R/ch-history.R    | 1 +
 R/ch-submit.R     | 1 +
 man/ch_history.Rd | 3 +++
 man/ch_submit.Rd  | 3 +++
 7 files changed, 14 insertions(+), 2 deletions(-)
 create mode 100644 CRAN-SUBMISSION

diff --git a/.Rbuildignore b/.Rbuildignore
index 38a171c..9ad5b19 100644
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -10,3 +10,4 @@
 ^docs$
 ^pkgdown$
 ^cran-comments\.md$
+^CRAN-SUBMISSION$
diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION
new file mode 100644
index 0000000..4b79f85
--- /dev/null
+++ b/CRAN-SUBMISSION
@@ -0,0 +1,3 @@
+Version: 0.1.0
+Date: 2024-04-23 22:39:05 UTC
+SHA: e13ed96bef73555af4db093ed12609bf359873d6
diff --git a/DESCRIPTION b/DESCRIPTION
index 44f92c3..a8aa01e 100644
--- a/DESCRIPTION
+++ b/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,
diff --git a/R/ch-history.R b/R/ch-history.R
index 8a68019..adc4cc5 100644
--- a/R/ch-history.R
+++ b/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)) {
diff --git a/R/ch-submit.R b/R/ch-submit.R
index fe30599..baadb0c 100644
--- a/R/ch-submit.R
+++ b/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)
diff --git a/man/ch_history.Rd b/man/ch_history.Rd
index 50e2dcc..a19fd72 100644
--- a/man/ch_history.Rd
+++ b/man/ch_history.Rd
@@ -10,6 +10,9 @@ ch_history(x = NULL)
 \item{x}{An list object that contains chat history. Use this argument to
 override the current history.}
 }
+\value{
+A list object with the current chat history
+}
 \description{
 Displays the current session' chat history
 }
diff --git a/man/ch_submit.Rd b/man/ch_submit.Rd
index 15fe94f..e28063f 100644
--- a/man/ch_submit.Rd
+++ b/man/ch_submit.Rd
@@ -30,6 +30,9 @@ prompt (TRUE)}
 
 \item{...}{Optional arguments; currently unused.}
 }
+\value{
+The output from the model currently in use.
+}
 \description{
 Method to easily integrate to new LLM API's
 }