doc: proper markdown escaping -> \_\_, \*, \_

PR-URL: https://github.com/nodejs/node/pull/4805
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

diff --git a/doc/api/globals.markdown b/doc/api/globals.markdown
index 5ac7bd9a0c3aa9b3b1f33feef7f5e6b0545887df..a8998d7e4af153975013d8f417047caf8081b72a 100644 (file)
--- a/doc/api/globals.markdown
+++ b/doc/api/globals.markdown
@@ -13,7 +13,7 @@ actually in the global scope but in the module scope - this will be noted.
 
 Used to handle binary data. See the [buffer section][].
 
-## __dirname
+## \_\_dirname
 
 <!-- type=var -->
 
@@ -28,7 +28,7 @@ Example: running `node example.js` from `/Users/mjr`
 
 `__dirname` isn't actually a global but rather local to each module.
 
-## __filename
+## \_\_filename
 
 <!-- type=var -->
 

diff --git a/doc/api/path.markdown b/doc/api/path.markdown
index 454c79353f7b3c9d1a81feb384dafa32dd243e17..506d94a3a755d15e3f4f14276e638fa84e638d88 100644 (file)
--- a/doc/api/path.markdown
+++ b/doc/api/path.markdown
@@ -26,7 +26,7 @@ Example:
 
 The platform-specific path delimiter, `;` or `':'`.
 
-An example on *nix:
+An example on \*nix:
 
     console.log(process.env.PATH)
     // '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'
@@ -161,7 +161,7 @@ Example:
 
 Returns an object from a path string.
 
-An example on *nix:
+An example on \*nix:
 
     path.parse('/home/user/dir/file.txt')
     // returns
@@ -260,7 +260,7 @@ Examples:
 
 The platform-specific file separator. `'\\'` or `'/'`.
 
-An example on *nix:
+An example on \*nix:
 
     'foo/bar/baz'.split(path.sep)
     // returns

diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown
index 7d5d8c420d6a814355b710ca5d3775e7f01d5516..29db04394ecfbba3a4315acc02a1c115c3ae433f 100644 (file)
--- a/doc/api/stream.markdown
+++ b/doc/api/stream.markdown
@@ -870,14 +870,14 @@ Note: **Implement this method, but do NOT call it directly.**
 
 This method is prefixed with an underscore because it is internal to the
 class that defines it and should only be called by the internal Readable
-class methods. All Readable stream implementations must provide a _read
+class methods. All Readable stream implementations must provide a \_read
 method to fetch data from the underlying resource.
 
-When _read is called, if data is available from the resource, `_read` should
+When \_read is called, if data is available from the resource, `_read` should
 start pushing that data into the read queue by calling `this.push(dataChunk)`.
 `_read` should continue reading from the resource and pushing data until push
 returns false, at which point it should stop reading from the resource. Only
-when _read is called again after it has stopped should it start reading
+when \_read is called again after it has stopped should it start reading
 more data from the resource and pushing that data onto the queue.
 
 Note: once the `_read()` method is called, it will not be called again until