v4 backport: doc: unify dirname and filename description #10968
Closed
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
jasnell
approved these changes
Jan 24, 2017
doc/api/globals.md
Outdated
| The directory name of the current module. This the same as the | ||
| [`path.dirname()`][] of the [`__filename`][]. | ||
|
|
||
| `__dirname` isn't actually a global but rather local to each module. |
Member
There was a problem hiding this comment.
please avoid the use of contractions in the docs. s/isn't/is not/
I know this was like this already but while you're in here changing things :-)
2 tasks
Contributor
Author
|
PTAL @jasnell |
jasnell
approved these changes
Jan 24, 2017
Contributor
Author
|
PR is docs only, CI is irrelevant |
MylesBorins
force-pushed
the
v4.x-staging
branch
from
f5c57c7 to
735119c
Compare
Contributor
|
@sam-github needs a rebase |
sam-github
force-pushed
the
backport-10527
branch
from
997377a to
a78f0a4
Compare
__dirname is path.dirname(__filename), but its docs, specifically the attempt to describe javascript scope in terms of "running" and "executing" had drifted apart. Rework to describe one as a variation of the other, move the example, and just describe the names in terms of the module, and it's local variables rather than the ill defined execution concepts. Fix: nodejs#5525 PR-URL: nodejs#10527 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
sam-github
force-pushed
the
backport-10527
branch
from
a78f0a4 to
dd97788
Compare
Contributor
Author
|
@MylesBorins apologies for the delay, rebased |
Contributor
|
landed in f97bfb227f |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
#10527 (comment)