diff --git a/DESCRIPTION b/DESCRIPTION index e78682f..ebed4ed 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,9 +1,9 @@ Type: Package Package: settingsSync Title: 'Rstudio' Addin to Sync Settings and Keymaps -Version: 3.0.0 +Version: 3.0.1 Description: Provides a 'Rstudio' addin to download, merge and upload 'Rstudio' - settings and keymaps, essencially 'syncing them' at will. It uses Google Drive + settings and keymaps, essentially 'syncing them' at will. It uses 'Google Drive' as a cloud storage to keep the settings and keymaps files. License: Apache License (== 2) URL: https://github.com/notPlancha/settingsSync @@ -24,3 +24,6 @@ NeedsCompilation: no RoxygenNote: 7.3.1 Authors@R: person("André", "Plancha", , "andre.plancha@hotmail.com", role = c("aut", "cre")) +Suggests: + spelling +Language: en-US diff --git a/R/mimic.R b/R/mimic.R index e857704..83d8c5c 100644 --- a/R/mimic.R +++ b/R/mimic.R @@ -4,9 +4,9 @@ #' These functions are used to simulate the main functions before truly running #' them, to disable changes to the files and to the cloud. #' -#' This are used in most examples so the user settings don't change +#' These are used in most examples, so the user settings don't change #' when running [utils::example()]. Internally, these change the options -#' "ss.mimic", "ss.mimic.local" and "ss.mimic.cloud". +#' `ss.mimic`, `ss.mimic.local` and `ss.mimic.cloud`. #' #' @returns nothing #' diff --git a/R/sync.R b/R/sync.R index 94a2a7a..0974c12 100644 --- a/R/sync.R +++ b/R/sync.R @@ -2,7 +2,7 @@ #' #' Pushes Rstudio settings to Google Drive, without pulling. This is just a #' helper function for [sync()], the main function, but can be used alone, although -#' this fucntion will not do any checking, and will just override. +#' this function will not do any checking, and will just override. #' Because of the way [googledrive::drive_put] is built, this function reads from #' the files directly. #' @@ -136,7 +136,7 @@ pull <- function( #' #' @param write boolean, if TRUE will write the merged settings to the local files, #' and push them to Google Drive. FALSE essentially just makes conflict resolution, -#' without changing any files (basically a dry run). If a value orther than NULL +#' without changing any files (basically a dry run). If a value other than NULL #' is provided, this will skip confirmation. #' @param useProgBar boolean, if TRUE will show a progress bar. Default is TRUE. #' @export @@ -298,7 +298,7 @@ read_from_local <- function(what) { #' #' @param df A merged data frame with 2 rows, with the contents of the local and cloud files #' -#' @returns df, ready to be jsoned, without conflicts +#' @returns df, ready to be json'ed, without conflicts #' #' @seealso [sync()], [choose()] #' @noRd diff --git a/README.md b/README.md index 45d4e74..a7e3df3 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ devtools::install_github("notPlancha/settingsSync") pak::pak("notPlancha/settingsSync") # or pak::pak("notPlancha/settingsSync@2.0.0") If you want a specific version ``` -Version 2.0.0 is imcompatible with CRAN policies, because it writes the files by default but it has a generally better api because of it. +Version 2.0.0 is incompatible with CRAN policies, because it writes the files by default but it has a generally better api because of it. Otherwise it's generally the same IMO. ## Usage diff --git a/inst/WORDLIST b/inst/WORDLIST new file mode 100644 index 0000000..8ed7d59 --- /dev/null +++ b/inst/WORDLIST @@ -0,0 +1,26 @@ +Addin +CMD +JSON +Keymaps +Rstudio +addin +addins +api +conda +config +dir +fromJSON +gd +github +googledrive +json +jsonlite +keymaps +param +params +pixi +pre +rappdirs +rstudio +ss +usethis diff --git a/man/mimic-on-off.Rd b/man/mimic-on-off.Rd index 36f1940..e9f9258 100644 --- a/man/mimic-on-off.Rd +++ b/man/mimic-on-off.Rd @@ -21,9 +21,9 @@ These functions are used to simulate the main functions before truly running them, to disable changes to the files and to the cloud. } \details{ -This are used in most examples so the user settings don't change +These are used in most examples, so the user settings don't change when running [utils::example()]. Internally, these change the options -"ss.mimic", "ss.mimic.local" and "ss.mimic.cloud". +`ss.mimic`, `ss.mimic.local` and `ss.mimic.cloud`. } \section{Functions}{ \itemize{ diff --git a/man/push.Rd b/man/push.Rd index c07d685..f79d06b 100644 --- a/man/push.Rd +++ b/man/push.Rd @@ -28,7 +28,7 @@ nothing \description{ Pushes Rstudio settings to Google Drive, without pulling. This is just a helper function for [sync()], the main function, but can be used alone, although -this fucntion will not do any checking, and will just override. +this function will not do any checking, and will just override. Because of the way [googledrive::drive_put] is built, this function reads from the files directly. } diff --git a/man/sync.Rd b/man/sync.Rd index a1f0d79..f197511 100644 --- a/man/sync.Rd +++ b/man/sync.Rd @@ -9,7 +9,7 @@ sync(write = NULL, useProgBar = TRUE) \arguments{ \item{write}{boolean, if TRUE will write the merged settings to the local files, and push them to Google Drive. FALSE essentially just makes conflict resolution, -without changing any files (basically a dry run). If a value orther than NULL +without changing any files (basically a dry run). If a value other than NULL is provided, this will skip confirmation.} \item{useProgBar}{boolean, if TRUE will show a progress bar. Default is TRUE.} diff --git a/tests/spelling.R b/tests/spelling.R new file mode 100644 index 0000000..e55675d --- /dev/null +++ b/tests/spelling.R @@ -0,0 +1,3 @@ +if(requireNamespace('spelling', quietly = TRUE)) + spelling::spell_check_test(vignettes = TRUE, error = TRUE, + skip_on_cran = TRUE)