doc: unify dirname and filename description #10527
Merged
Conversation
This file contains 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
nodejs-github-bot
added
doc
cjihrig
reviewed
Dec 29, 2016
| For a main program this is not necessarily the same as the file name used in the | ||
| command line. | ||
|
|
||
| See [`__dirname`][] for the director name of the current module. |
sam-github
force-pushed
the
unify-dirname-and-filename-docs
branch
from
c7ce4c5
to
da13a15
Compare
jasnell
reviewed
Dec 29, 2016
| 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. |
There was a problem hiding this comment.
The wording could be a bit better...
The directory name of the current module. The same value as that returned
by `path.dirname(__filename)`.
There was a problem hiding this comment.
Yes, reads better, but if I write it like that its hard to get __filename linked, I'll try to figure out a way.
There was a problem hiding this comment.
Found a way, PTAL
jasnell
approved these changes
Dec 29, 2016
gibfahn
approved these changes
Dec 30, 2016
sam-github
force-pushed
the
unify-dirname-and-filename-docs
branch
from
ee5fcc7
to
134481d
Compare
evanlucas
pushed a commit
that referenced
this pull request
Jan 4, 2017
__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: #5525 PR-URL: #10527 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Jan 23, 2017
__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: #5525 PR-URL: #10527 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
|
did not land cleanly on v4.x. Feel free to manually backport |
MylesBorins
pushed a commit
that referenced
this pull request
Jan 24, 2017
__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: #5525 PR-URL: #10527 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Jan 31, 2017
__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: #5525 PR-URL: #10527 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
sam-github
added a commit
to sam-github/node
that referenced
this pull request
Feb 13, 2017
__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>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 21, 2017
__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: #5525 PR-URL: #10527 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 21, 2017
__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: #5525 PR-URL: #10527 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
__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: #5525
Checklist
Affected core subsystem(s)
doc