Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update evaluating.qmd #228

Merged
merged 2 commits into from
Jul 21, 2023
Merged

Update evaluating.qmd #228

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd180aa
Update evaluating.qmd
bahadzie Jun 15, 2023
4a7f205
Whitespace
georgestagg Jul 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/docs/evaluating.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The normal stream output is written to the JavaScript console. The error stream

### Returning JavaScript values when evaluating R code

A selection of convenience methods return the result of evaluating R code as a promise resolving to a JavaScript object, rather than an `RObject` reference. The benefit is that since the returned object is of a raw JavaScript type, it does not need to be memory managed like an `RObject` result would be.
A selection of convenience methods return the result of evaluating R code as a promise to a JavaScript object, rather than an `RObject` reference. The benefit is that since the returned object is of a raw JavaScript type, it does not need to be memory managed like an `RObject` result would be.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is removing the word "resolving" here deliberate? It's not duplicated in this instance.


| Method | Returned object type |
|-----------------------------------------------|------------------------|
Expand Down Expand Up @@ -59,7 +59,7 @@ The method takes two arguments,
- `code` - The R code to evaluate
- `options` - Optional: A [`EvalROptions`](api/js/interfaces/WebRChan.EvalROptions.md) object controlling how the code is evaluated.

A promise is returned resolving resolving to a JavaScript object with two properties,
A promise is returned resolving to a JavaScript object with two properties,

- `result` - The result of the computation, as an [`RObject`](api/js/modules/RMain.md#robject) proxy.
- `output` - Output captured during execution, an array of objects with properties `type` and `data`.
Expand Down