doc: clarify that __dirname is module local

jasnell · Myles Borins · commit 0ae5d027c676 · 2016-04-05T10:31:43.000-07:00
Fixes: #5525 PR-URL: #6018 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Roman Klauke <romaaan.git@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
diff --git a/doc/api/globals.markdown b/doc/api/globals.markdown
@@ -30,6 +30,16 @@ console.log(__dirname);
 
 `__dirname` isn't actually a global but rather local to each module.
 
+For instance, given two modules: `a` and `b`, where `b` is a dependency of
+`a` and there is a directory structure of:
+
+* `/Users/mjr/app/a.js`
+* `/Users/mjr/app/node_modules/b/b.js`
+
+References to `__dirname` within `b.js` will return
+`/Users/mjr/app/node_modules/b` while references to `__dirname` within `a.js`
+will return `/Users/mj/app`.
+
 ## \_\_filename
 
 <!-- type=var -->
