Minor doc updates

jrdnbradford · Jul 19, 2024 · 69c397b · 69c397b
1 parent 498e56a
commit 69c397b
Show file tree

Hide file tree

Showing 71 changed files with 277 additions and 277 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: lovecraftr
 Type: Package
 Title: H. P. Lovecraft's works, for text analysis
-Version: 0.2.2
+Version: 0.2.3
 Authors@R:
     person("Jordan", "Bradford", email = "[email protected]", role = c("aut", "cre"))
 Description: A collection of H. P. Lovecraft's works as R datasets.

diff --git a/R/data.R b/R/data.R
diff --git a/data-raw/generate_data.R b/data-raw/generate_data.R
@@ -27,8 +27,8 @@ header <- "# This documentation is generated by a script, do not edit by hand
 "
 
 docs_template <- "{header}
-#' @title Dataset of {formatted_title}
-#' @description A dataset containing text of H. P. Lovecraft's {formatted_title}
+#' @title {formatted_title}
+#' @description A dataset containing text of H. P. Lovecraft's {formatted_title}.
 #' @usage data({dataset_name})
 #' @format A character vector with {num_vectors} elements, with roughly 80 characters per line.
 #' @docType data
@@ -69,7 +69,7 @@ lovecraft <- dplyr::bind_rows(dataset_list)
 num_rows <- scales::number(nrow(lovecraft), big.mark = ",")
 num_cols <- ncol(lovecraft)
 corpus_docs <- glue::glue("{header}
-#' @title Dataset of Lovecraft's corpus
+#' @title Dataset of Lovecraft's Corpus
 #' @description A dataset containing text of all the H. P. Lovecraft works available in this package.
 #' @usage data(lovecraft)
 #' @format A tibble with {num_rows} rows and {num_cols} columns:

diff --git a/man/at_the_mountains_of_madness.Rd b/man/at_the_mountains_of_madness.Rd
diff --git a/man/azathoth.Rd b/man/azathoth.Rd
diff --git a/man/beyond_the_wall_of_sleep.Rd b/man/beyond_the_wall_of_sleep.Rd
diff --git a/man/celephais.Rd b/man/celephais.Rd
diff --git a/man/cool_air.Rd b/man/cool_air.Rd
diff --git a/man/dagon.Rd b/man/dagon.Rd
diff --git a/man/dreams_in_the_witch_house.Rd b/man/dreams_in_the_witch_house.Rd
diff --git a/man/ex_oblivione.Rd b/man/ex_oblivione.Rd
diff --git a/man/facts_concerning_the_late_arthur_jermyn_and_his_family.Rd b/man/facts_concerning_the_late_arthur_jermyn_and_his_family.Rd
diff --git a/man/from_beyond.Rd b/man/from_beyond.Rd
diff --git a/man/he.Rd b/man/he.Rd
diff --git a/man/herbert_west_reanimator.Rd b/man/herbert_west_reanimator.Rd
diff --git a/man/hypnos.Rd b/man/hypnos.Rd
diff --git a/man/imprisoned_with_the_pharoahs.Rd b/man/imprisoned_with_the_pharoahs.Rd
diff --git a/man/in_the_vault.Rd b/man/in_the_vault.Rd
diff --git a/man/lovecraft_corpus.Rd b/man/lovecraft_corpus.Rd
diff --git a/man/medusas_coil.Rd b/man/medusas_coil.Rd
diff --git a/man/memory.Rd b/man/memory.Rd
diff --git a/man/nyarlathotep.Rd b/man/nyarlathotep.Rd
diff --git a/man/pickmans_model.Rd b/man/pickmans_model.Rd