We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent b218973 commit 4dc4b1cCopy full SHA for 4dc4b1c
2 files changed
.github/workflows/r-universe-check.yaml
RcppTskit/R/RcppTskit-package.R
@@ -152,9 +152,9 @@
152
#' then the function directly attempts to install and import tskit before
153
#' returning it.
154
#' @details This function is meant for users running \code{tskit <- get_tskit_py()}
155
-#' or similar, but also by other functions in this package that need the
156
-#' \code{tskit} reticulate Python module, yet we don't want to keep importing
157
-#' it if it already has been imported.
+#' or similar code, but also by other functions in this package that need the
+#' \code{tskit} reticulate Python module. The point of \code{get_tskit_py} is
+#' to avoid importing the module repeatedly, if it already has been imported.
158
#' @return \code{tskit} reticulate Python module.
159
#' @examples
160
#' tskit <- get_tskit_py()
0 commit comments