Print environment contents when loading it. #133
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hipercow silently attaches packages and sources files from the configured environment. If something goes wrong in this process (eg. the file does not exist), it can be difficult for users to understand what is happening. None of their own code makes any mention of the files or packages in question, and they may have forgotten that they ever created the environment. This prints a message when loading the environment, with the list of files and packages that will be loaded. This should provide enough hints for the user to make the connection between a hypothetical error and the environment.
plietar
commented
Jun 28, 2024
| @@ -38,7 +38,7 @@ task_eval <- function(id, envir = .GlobalEnv, verbose = FALSE, root = NULL) { | |||
| version <- utils::packageVersion("hipercow") | |||
| cli::cli_h1("hipercow {version} running at '{root$path$root}'") | |||
| cli::cli_alert_info("library paths:") | |||
| cli::cli_li(.libPaths()) | |||
| cli::cli_ul(.libPaths()) | |||
There was a problem hiding this comment.
cli_li was leaving a container open, which then indented all other bullet points in the function.
cli_ul does not have this problem, as it closes the container when given a non-NULL argument.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
hipercow silently attaches packages and sources files from the configured environment. If something goes wrong in this process (eg. the file does not exist), it can be difficult for users to understand what is happening. None of their own code makes any mention of the files or packages in question, and they may have forgotten that they ever created the environment.
This prints a message when loading the environment, with the list of files and packages that will be loaded. This should provide enough hints for the user to make the connection between a hypothetical error and the environment.