Skip to content

Commit

Permalink
update details
Browse files Browse the repository at this point in the history
Co-authored-by: Josiah Parry <josiah.parry@gmail.com>
  • Loading branch information
kbvernon and JosiahParry authored Sep 7, 2024
1 parent dc543e3 commit 2205c95
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion R/use_msrv.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,14 @@
#' @param path character scalar, path to folder containing DESCRIPTION file
#'

Check warning on line 5 in R/use_msrv.R

View workflow job for this annotation

GitHub Actions / lint

file=R/use_msrv.R,line=5,col=3,[trailing_whitespace_linter] Trailing whitespace is superfluous.
#' @details
#' It is assumed that MSRV is greater than or equal to `version`. The result is

#' 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`.

Check warning on line 8 in R/use_msrv.R

View workflow job for this annotation

GitHub Actions / lint

file=R/use_msrv.R,line=8,col=121,[line_length_linter] Lines should not be more than 120 characters. This line is 223 characters.
#'

Check warning on line 9 in R/use_msrv.R

View workflow job for this annotation

GitHub Actions / lint

file=R/use_msrv.R,line=9,col=3,[trailing_whitespace_linter] Trailing whitespace is superfluous.
#' 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.

Check warning on line 10 in R/use_msrv.R

View workflow job for this annotation

GitHub Actions / lint

file=R/use_msrv.R,line=10,col=121,[line_length_linter] Lines should not be more than 120 characters. This line is 290 characters.
#'

Check warning on line 11 in R/use_msrv.R

View workflow job for this annotation

GitHub Actions / lint

file=R/use_msrv.R,line=11,col=3,[trailing_whitespace_linter] Trailing whitespace is superfluous.
#' 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.

Check warning on line 12 in R/use_msrv.R

View workflow job for this annotation

GitHub Actions / lint

file=R/use_msrv.R,line=12,col=121,[line_length_linter] Lines should not be more than 120 characters. This line is 253 characters.

Check warning on line 12 in R/use_msrv.R

View workflow job for this annotation

GitHub Actions / lint

file=R/use_msrv.R,line=12,col=253,[trailing_whitespace_linter] Trailing whitespace is superfluous.
#'

Check warning on line 13 in R/use_msrv.R

View workflow job for this annotation

GitHub Actions / lint

file=R/use_msrv.R,line=13,col=3,[trailing_whitespace_linter] Trailing whitespace is superfluous.
#' 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.

Check warning on line 14 in R/use_msrv.R

View workflow job for this annotation

GitHub Actions / lint

file=R/use_msrv.R,line=14,col=121,[line_length_linter] Lines should not be more than 120 characters. This line is 263 characters.
#' "SystemRequirements: Cargo (Rust's package manager), rustc >= `version`."
#'
#' @return `version`
Expand Down

0 comments on commit 2205c95

Please sign in to comment.