-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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.
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
doc: add notice about useGlobal option in repl docs #13866
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with a suggestion.
doc/api/repl.md
Outdated
@@ -406,6 +406,8 @@ changes: | |||
* `useGlobal` {boolean} If `true`, specifies that the default evaluation | |||
function will use the JavaScript `global` as the context as opposed to | |||
creating a new separate context for the REPL instance. Defaults to `false`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it should be adequate to say:
The CLI REPL sets this value to true
. Defaults to false
when used programmatically.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the key point is to make readers notice the default value is false
, while node CLI REPL use true
in comparison.
Your suggestion is good. I try to make it less wordy.
PR-URL: #13866 Fixes: #13827 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
Landed in 6e47e13 |
PR-URL: #13866 Fixes: #13827 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
PR-URL: #13866 Fixes: #13827 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
Add notice about the useGlobal option in repl docs.
Fixes: #13827
Checklist
Affected core subsystem(s)
doc