docs: Document on_load() detail
#1696
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
lionel-
reviewed
Mar 13, 2024
Comment on lines
+72
to
+74
| #' The expressions inside `on_load()` do not undergo static analysis | ||
| #' by `R CMD check`. Therefore, it is advisable to only use | ||
| #' simple function calls inside `on_load()`. |
There was a problem hiding this comment.
I think we could add support for on_load to other tools so I'd remove the latter part:
Suggested change
| #' The expressions inside `on_load()` do not undergo static analysis | |
| #' by `R CMD check`. Therefore, it is advisable to only use | |
| #' simple function calls inside `on_load()`. | |
| #' Note that the expressions inside `on_load()` do not undergo static analysis | |
| #' by `R CMD check`. |
There was a problem hiding this comment.
I don't understand "support ... to other tools", I'm fine with the change if it makes sense to you.
There was a problem hiding this comment.
On the other hand extracting to a function also makes sense in terms of style. Let's just merge as is.
|
Thanks! |
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.
Closes #1695.