Add inline documentation for evalR methods #571
Conversation
This file contains hidden or 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
georgestagg
reviewed
Sep 23, 2025
Member
georgestagg
left a comment
georgestagg
left a comment
There was a problem hiding this comment.
Thanks, looks great! Some minor suggestions are below.
| * Evaluate the given R code, returning a promise for no return data. | ||
| * @param {string} code The R code to evaluate. | ||
| * @param {EvalROptions} [options] Options for the execution environment. | ||
| * @returns {Promise<undefined>} A promise which fires when the R code completes, but returns no data. |
Member
There was a problem hiding this comment.
Suggested change
| * @returns {Promise<undefined>} A promise which fires when the R code completes, but returns no data. | |
| * @returns {Promise<void>} A promise which fires when the R code completes, but returns no data. |
| * Evaluate the given R code, returning a promise for a boolean value. If the returned R value is not a boolean, an error will be thrown. | ||
| * @param {string} code The R code to evaluate. | ||
| * @param {EvalROptions} [options] Options for the execution environment. | ||
| * @returns {Promise<unknown>} The result of the computation. |
Member
There was a problem hiding this comment.
Suggested change
| * @returns {Promise<unknown>} The result of the computation. | |
| * @returns {Promise<boolean>} The result of the computation. |
| * Evaluate the given R code, returning a promise for a number. If the returned R value is not a number, an error will be thrown. | ||
| * @param {string} code The R code to evaluate. | ||
| * @param {EvalROptions} [options] Options for the execution environment. | ||
| * @returns {Promise<unknown>} The result of the computation. |
Member
There was a problem hiding this comment.
Suggested change
| * @returns {Promise<unknown>} The result of the computation. | |
| * @returns {Promise<number>} The result of the computation. |
| * Evaluate the given R code, returning a promise for a string. If the returned R value is not a string, an error will be thrown. | ||
| * @param {string} code The R code to evaluate. | ||
| * @param {EvalROptions} [options] Options for the execution environment. | ||
| * @returns {Promise<unknown>} The result of the computation. |
Member
There was a problem hiding this comment.
Suggested change
| * @returns {Promise<unknown>} The result of the computation. | |
| * @returns {Promise<string>} The result of the computation. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Contributes to but does NOT fix #436: the API documentation will need to be rebuilt and deployed.