Skip to content

Commit

Permalink
Rename help topic to "Julia-Setup", improve phrasing of documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stefan-m-lenz committed Sep 28, 2024
1 parent 184037f commit 9b83fde
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
10 changes: 5 additions & 5 deletions R/JuliaConnectoR-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
#' and that the Julia executable is in the system search \env{PATH} or that the
#' \env{JULIA_BINDIR} environment variable is set to the \code{bin} directory of
#' the Julia installation. For more details about the setup,
#' see \code{\link{Setup-JuliaConnectoR}}.
#' see \code{\link{Julia-Setup}}.
#'
#'
#' @section Function overview:
Expand Down Expand Up @@ -237,7 +237,7 @@ NULL

#' Julia setup
#'
#' Julia must be installed separately from the \pkg{JuliaConnectoR} package.
#' Julia must be installed separately in order for the \pkg{JuliaConnectoR} package to work.
#' You can download and install Julia from \href{https://julialang.org/downloads/}{https://julialang.org/downloads/}.
#'
#' \subsection{Setup via the Juliaup installation manager}{
Expand All @@ -246,10 +246,10 @@ NULL
#' }
#'
#' \subsection{Juliaup on Windows}{
#' On Windows, if you have freshly installed Juliaup, start Julia once on the command line.
#' If you have freshly installed Juliaup, start Julia once on the command line.
#' This will do the actual installation of the current Julia version.
#' Juliaup puts the Julia executable on the system \env{PATH}.
#' This way, the Julia installation can be detected by the \pkg{JuliaConnectoR}
#' This way, the Julia installation can be detected by the \pkg{JuliaConnectoR}.
#' }
#'
#' \subsection{Juliaup on Mac}{
Expand All @@ -275,5 +275,5 @@ NULL
#' than the one in your system \env{PATH}.
#' }
#'
#' @name Setup-JuliaConnectoR
#' @name Julia-Setup
NULL
2 changes: 1 addition & 1 deletion R/connecting.R
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ fallbackOnDefaultJuliaupPath <- function() {
stop('Julia could not be found.
Julia needs to be installed and findable for the "JuliaConnectoR" package to work.
After installing Julia, the best way make Julia findable is to put the folder containing the Julia executable into the PATH environment variable.
For more information, see the help topic ?`Setup-JuliaConnectoR`.
For more information, see the help topic ?`Julia-Setup`.
')
} else {
return(juliaCmd)
Expand Down
10 changes: 5 additions & 5 deletions man/Setup-JuliaConnectoR.Rd → man/Julia-Setup.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/JuliaConnectoR-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tests/testthat/test.R
Original file line number Diff line number Diff line change
Expand Up @@ -1113,7 +1113,7 @@ test_that("Fallback on juliaup fails correctly", {
skip_on_cran()
juliaCmdJuliaup <- file.path(Sys.getenv("HOME"), ".juliaup", "bin", "julia")
if (!file.exists(juliaCmdJuliaup)) {
expect_error(JuliaConnectoR:::fallbackOnDefaultJuliaupPath(), regexp = "\\?`Setup-JuliaConnectoR`")
expect_error(JuliaConnectoR:::fallbackOnDefaultJuliaupPath(), regexp = "\\?`Julia-Setup`")
} else {
expect_equal(juliaCmdJuliaup, JuliaConnectoR:::fallbackOnDefaultJuliaupPath())
}
Expand Down

0 comments on commit 9b83fde

Please sign in to comment.