doc: mention existence/purpose of module wrapper by mtharrison · Pull Request #6433 · nodejs/node

mtharrison · 2016-04-27T22:44:44Z

Checklist

documentation is changed or added
the commit message follows commit guidelines

Affected core subsystem(s)

doc

Description of change

Included a block in the modules.md file to explain the existence and
purpose of the module wrapper

Fishrock123 · 2016-04-27T23:02:50Z

Seems fine to me, but I might be missing some context. cc @nodejs/documentation

cjihrig · 2016-04-27T23:07:47Z

LGTM, but could you also update the statement that I referenced in #6427 (comment).

Slayer95 · 2016-04-28T03:08:58Z

Note that, as is, this opens the possibility that people -god forbid- start accessing arguments from modules...

mtharrison · 2016-04-28T08:21:28Z

@cjihrig sure, updated!

cjihrig · 2016-04-28T13:46:35Z

doc/api/modules.md

Extra space after "to"

cjihrig · 2016-04-28T15:12:42Z

LGTM, but let's wait a day or so to let other collaborators weigh in.

thefourtheye · 2016-04-28T15:17:24Z

doc/api/modules.md

thing? Wouldn't code be better?

evanlucas · 2016-04-28T15:28:47Z

LGTM with mine and @thefourtheye's nits. Thanks for the PR @mtharrison!

Also, can you update the commit title and message to conform to https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-3-commit? Specifically, the title and body line lengths. Thanks!

mtharrison · 2016-04-28T15:44:05Z

@evanlucas Thanks. I squashed into a single commit. Which looks like it conforms. Is it correct?

addaleax · 2016-04-28T15:53:17Z

doc/api/modules.md

I wouldn’t reference V8 here directly, as this does not depend on the specific engine that’s being used.

ah good point @addaleax

@addaleax @evanlucas Do you have any suggestions for something more appropriate? Some ideas:

s/V8/the JavaScript [runtime|engine]

Change the whole sentence to "Before Node.js executes the code in your module, it wraps it in..."

I like the change the whole sentence idea

@evanlucas thanks, updated accordingly.

evanlucas · 2016-04-28T16:06:50Z

@mtharrison commit message looks good. Thanks!

jasnell · 2016-04-29T03:55:56Z

doc/api/modules.md

I know this particular document is riddled with you and your, which we should get refactored out later.. can you reword this to avoid adding a new instance of your? Perhaps, Before a module's code is executed, Node.js will wrap it with a function wrapper.

jasnell · 2016-04-29T03:57:05Z

Left some comments. LGTM otherwise.

Included a block in the modules.md file to explain the existence and purpose of the module wrapper.

mtharrison · 2016-05-03T18:26:49Z

@jasnell Thanks, I've addressed those issues now.

jasnell · 2016-05-03T18:45:37Z

Thank you!

Included a block in the modules.md file to explain the existence and purpose of the module wrapper. PR-URL: #6433 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com>

evanlucas · 2016-05-10T11:50:08Z

Landed in 7164003. Thanks!

Included a block in the modules.md file to explain the existence and purpose of the module wrapper. PR-URL: #6433 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com>

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 27, 2016

mtharrison mentioned this pull request Apr 27, 2016

SyntaxError showing token not in the input #6427

Closed

mscdex added the module Issues and PRs related to the module subsystem. label Apr 28, 2016

mtharrison force-pushed the doc-module-wrapper branch from b9a9973 to 59523ae Compare April 28, 2016 08:17

mtharrison force-pushed the doc-module-wrapper branch from 59523ae to 6e9de4e Compare April 28, 2016 08:22

cjihrig reviewed Apr 28, 2016
View reviewed changes

thefourtheye reviewed Apr 28, 2016
View reviewed changes

mtharrison force-pushed the doc-module-wrapper branch from f609afc to fbe510a Compare April 28, 2016 15:42

addaleax reviewed Apr 28, 2016
View reviewed changes

mtharrison force-pushed the doc-module-wrapper branch from fbe510a to be86e84 Compare April 28, 2016 21:33

jasnell reviewed Apr 29, 2016
View reviewed changes

doc: mention existence/purpose of module wrapper

696fc71

Included a block in the modules.md file to explain the existence and purpose of the module wrapper.

mtharrison force-pushed the doc-module-wrapper branch from be86e84 to 696fc71 Compare May 3, 2016 18:26

evanlucas closed this May 10, 2016

mtharrison deleted the doc-module-wrapper branch May 10, 2016 11:52

evanlucas mentioned this pull request May 17, 2016

2016-05-17, Version 6.2.0 (Stable) #6810

Merged

MylesBorins added the land-on-v4.x label Jun 2, 2016

MylesBorins mentioned this pull request Jun 24, 2016

v4.4.7 proposal #7395

Merged

Uh oh!

Conversation

mtharrison commented Apr 27, 2016

Checklist

Affected core subsystem(s)

Description of change

Uh oh!

Fishrock123 commented Apr 27, 2016

Uh oh!

cjihrig commented Apr 27, 2016

Uh oh!

Slayer95 commented Apr 28, 2016

Uh oh!

mtharrison commented Apr 28, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cjihrig commented Apr 28, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

evanlucas commented Apr 28, 2016

Uh oh!

mtharrison commented Apr 28, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

evanlucas commented Apr 28, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jasnell commented Apr 29, 2016

Uh oh!

mtharrison commented May 3, 2016

Uh oh!

jasnell commented May 3, 2016

Uh oh!

evanlucas commented May 10, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants