Skip to content

Commit

Permalink
reformat again - trim whitespace
Browse files Browse the repository at this point in the history
  • Loading branch information
kbvernon committed Sep 7, 2024
1 parent f8f74c6 commit ebb2f18
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions R/use_msrv.R
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
#' Set the minimum supported rust version (MSRV)
#'
#'
#' `use_msrv()` sets the minimum supported rust version for your R package.
#'
#'
#' @param version character scalar, the minimum supported Rust version
#' @param path character scalar, path to folder containing DESCRIPTION file
#'
#' @details
#'
#' The minimum supported rust version (MSRV) is determined by the
#' `SystemRequirements` field in a package's `DESCRIPTION` file. For example, to
#' set the MSRV to `1.67.0`, the `SystemRequirements` must have
#'
#' The minimum supported rust version (MSRV) is determined by the
#' `SystemRequirements` field in a package's `DESCRIPTION` file. For example, to
#' set the MSRV to `1.67.0`, the `SystemRequirements` must have
#' `rustc >= 1.67.0`.
#'
#' By default, there is no MSRV set. However, some crates have features that
#' depend on a minimum version of Rust. As of this writing the version of Rust
#' on CRAN's Fedora machine's is 1.69. If you require a version of Rust that is
#' By default, there is no MSRV set. However, some crates have features that
#' depend on a minimum version of Rust. As of this writing the version of Rust
#' on CRAN's Fedora machine's is 1.69. If you require a version of Rust that is
#' greater than that, you must set it in your DESCRIPTION file.
#'
#' It is also important to note that if CRAN's machines do not meet the
#' specified MSRV, they will not be able to build a binary of your package. As a
#' consequence, if users try to install the package they will be required to
#' It is also important to note that if CRAN's machines do not meet the
#' specified MSRV, they will not be able to build a binary of your package. As a
#' consequence, if users try to install the package they will be required to
#' have Rust installed as well.
#'
#' To determine the MSRV of your R package, we recommend installing the
#' `cargo-msrv` cli. You can do so by running `cargo install cargo-msrv`. To
#' determine your MSRV, set your working directory to `src/rust` then run
#' To determine the MSRV of your R package, we recommend installing the
#' `cargo-msrv` cli. You can do so by running `cargo install cargo-msrv`. To
#' determine your MSRV, set your working directory to `src/rust` then run
#' `cargo msrv`. Note that this may take a while.
#'
#' For more details, please see
#' For more details, please see
#' [cargo-msrv](https://github.com/foresterre/cargo-msrv).
#'
#' @return `version`
Expand All @@ -41,7 +41,7 @@
use_msrv <- function(version, path = ".") {
if (length(version) != 1L) {
cli::cli_abort(
"Version must be a character scalar",
"Version must be a character scalar",
class = "rextendr_error"
)
}
Expand Down Expand Up @@ -74,7 +74,7 @@ use_msrv <- function(version, path = ".") {
} else if (!identical(cur, prev)) {
cli::cli_ul(
c(
"The SystemRequirements field in the {.file DESCRIPTION} file is
"The SystemRequirements field in the {.file DESCRIPTION} file is
already set.",
"Please update it manually if needed.",
"{.code SystemRequirements: {cur}}"
Expand Down

0 comments on commit ebb2f18

Please sign in to comment.