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.

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: move module-specific "globals" to modules.md #13962

Closed
wants to merge 2 commits into from

Conversation

tniessen
Copy link
Member

Fixes: #13953

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@tniessen tniessen added doc Issues and PRs related to the documentations. module Issues and PRs related to the module subsystem. labels Jun 28, 2017
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jun 28, 2017
@@ -2,8 +2,15 @@

<!-- type=misc -->

These objects are available in all modules. Some of these objects aren't
actually in the global scope but in the module scope - this will be noted.
These objects are available in all modules. The following global-looking
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion:

The following variables may appear to be global but are not. They exist only in the scope of modules, see the module system documentation.

They would show up better in the TOC if each was listed in its original place instead of this bullet list, but with the docs replaced with a explanation and a link to the module system docs.

Copy link
Member Author

Choose a reason for hiding this comment

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

That could also reduce problems with old links 👍

@tniessen tniessen self-assigned this Jun 28, 2017
@tniessen
Copy link
Member Author

@sam-github PTAL

@tniessen
Copy link
Member Author

Landed in d111319.

@tniessen tniessen closed this Jun 30, 2017
tniessen added a commit that referenced this pull request Jun 30, 2017
PR-URL: #13962
Fixes: #13953
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
addaleax pushed a commit to addaleax/node that referenced this pull request Jul 3, 2017
PR-URL: nodejs#13962
Fixes: nodejs#13953
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@addaleax addaleax mentioned this pull request Jul 3, 2017
addaleax pushed a commit that referenced this pull request Jul 11, 2017
PR-URL: #13962
Fixes: #13953
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
addaleax pushed a commit that referenced this pull request Jul 18, 2017
PR-URL: #13962
Fixes: #13953
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@MylesBorins
Copy link
Contributor

This does not land cleanly in LTS. Please feel free to manually backport by following the guide. Please also feel free to replace do-not-land if it is being backported

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. module Issues and PRs related to the module subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for __dirname is incorrect
6 participants