node/doc/api
Sam Roberts 134481dbe9 doc: unify dirname and filename description
__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: https://github.com/nodejs/node/issues/5525
PR-URL: https://github.com/nodejs/node/pull/10527
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2017-01-03 13:39:32 -08:00
..
_toc.md doc: subdivide TOC, add auxiliary links 2016-04-29 13:27:18 -04:00
addons.md doc: var => const in js code examples of addons.md 2016-12-03 14:12:50 +01:00
all.md doc: git mv to .md 2016-04-20 16:34:27 -07:00
assert.md doc: fix typo in assert code example 2016-11-22 17:27:05 +01:00
buffer.md buffer: allow Uint8Array input to methods 2016-12-21 07:48:14 +01:00
child_process.md doc: warn about unvalidated input in child_process 2016-12-30 09:26:30 -08:00
cli.md src: Node Tracing Controller 2016-12-20 12:31:09 -08:00
cluster.md doc: modernize code examples in the cluster.md 2016-12-22 09:18:57 -05:00
console.md doc: more efficient example in the console.md 2016-12-27 13:16:13 -08:00
crypto.md doc: rework tls for accuracy and clarity 2016-12-12 08:15:58 -08:00
debugger.md src: Node Tracing Controller 2016-12-20 12:31:09 -08:00
dgram.md doc: improve rinfo object documentation 2016-12-27 21:31:01 -08:00
dns.md doc: remove backtick escaping for manpage refs 2016-11-20 00:56:25 +01:00
documentation.md doc: use blockquotes for Stability: markers 2016-08-04 22:43:34 +02:00
domain.md doc: consistent 'Returns:' part two 2016-12-23 12:16:05 -05:00
errors.md doc: make comment indentation consistent 2016-11-16 07:52:57 +01:00
events.md doc: make comment indentation consistent 2016-11-16 07:52:57 +01:00
fs.md fs: support Uint8Array input to methods 2016-12-26 10:08:42 +01:00
globals.md doc: unify dirname and filename description 2017-01-03 13:39:32 -08:00
http.md doc: wrap long lines in http.request 2016-11-15 23:05:51 +01:00
https.md doc: changed order of invocations in https.request() example. 2016-11-24 15:45:43 -05:00
index.md doc: git mv to .md 2016-04-20 16:34:27 -07:00
modules.md doc: require() tries first core not native modules 2016-12-22 22:42:23 -08:00
net.md doc: strip trailing whitespace 2016-11-18 09:26:38 -08:00
os.md doc: add return types and props types to OS module 2016-11-18 23:24:32 +01:00
path.md doc: fix typo in code example of 'path' module 2016-12-12 16:06:39 +01:00
process.md doc: clarify information about ABI version 2016-12-28 09:02:33 -08:00
punycode.md doc: use blockquotes for Stability: markers 2016-08-04 22:43:34 +02:00
querystring.md doc: fix "hashOwnProperty" typo in querystring 2016-08-15 10:42:38 -07:00
readline.md doc: remove backtick escaping for manpage refs 2016-11-20 00:56:25 +01:00
repl.md doc: add the valid link for curl(1) in repl.md 2016-12-25 19:50:35 +01:00
stream.md doc: fixup errors in stream.md 2016-12-27 13:42:41 -08:00
string_decoder.md doc: use blockquotes for Stability: markers 2016-08-04 22:43:34 +02:00
synopsis.md doc: various documentation formatting fixes 2016-07-14 12:26:50 +03:00
timers.md doc: enable no-file-name-articles remark-lint rule 2016-09-27 07:07:40 -07:00
tls.md doc: add tls.DEFAULT_ECDH_CURVE 2016-12-27 13:56:51 -08:00
tracing.md src: Node Tracing Controller 2016-12-20 12:31:09 -08:00
tty.md doc: add some info on tty#setRawMode() 2016-12-08 13:39:45 -05:00
url.md doc: clarify slashes-appending in url module 2016-11-23 20:57:39 -08:00
util.md doc: "util" is not needed to extend ES6 classes 2016-11-23 19:29:54 +01:00
v8.md src: extend HeapStatistics with new fields 2016-11-20 02:23:00 +01:00
vm.md doc: fix link to cli.md in vm.md 2016-11-08 20:30:28 +01:00
zlib.md doc: strip trailing whitespace 2016-11-18 09:26:38 -08:00