Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit f0b92f2

Browse files
eljefedelrodeodeljefeMyles Borins
authored and
Myles Borins
committedFeb 17, 2016
doc: proper markdown escaping -> \_\_, \*, \_
PR-URL: #4805 Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]>
1 parent da088a1 commit f0b92f2

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed
 

‎doc/api/globals.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ actually in the global scope but in the module scope - this will be noted.
1313

1414
Used to handle binary data. See the [buffer section][].
1515

16-
## __dirname
16+
## \_\_dirname
1717

1818
<!-- type=var -->
1919

@@ -28,7 +28,7 @@ Example: running `node example.js` from `/Users/mjr`
2828

2929
`__dirname` isn't actually a global but rather local to each module.
3030

31-
## __filename
31+
## \_\_filename
3232

3333
<!-- type=var -->
3434

‎doc/api/path.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Example:
2626

2727
The platform-specific path delimiter, `;` or `':'`.
2828

29-
An example on *nix:
29+
An example on \*nix:
3030

3131
console.log(process.env.PATH)
3232
// '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'
@@ -161,7 +161,7 @@ Example:
161161

162162
Returns an object from a path string.
163163

164-
An example on *nix:
164+
An example on \*nix:
165165

166166
path.parse('/home/user/dir/file.txt')
167167
// returns
@@ -260,7 +260,7 @@ Examples:
260260

261261
The platform-specific file separator. `'\\'` or `'/'`.
262262

263-
An example on *nix:
263+
An example on \*nix:
264264

265265
'foo/bar/baz'.split(path.sep)
266266
// returns

‎doc/api/stream.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -870,14 +870,14 @@ Note: **Implement this method, but do NOT call it directly.**
870870

871871
This method is prefixed with an underscore because it is internal to the
872872
class that defines it and should only be called by the internal Readable
873-
class methods. All Readable stream implementations must provide a _read
873+
class methods. All Readable stream implementations must provide a \_read
874874
method to fetch data from the underlying resource.
875875

876-
When _read is called, if data is available from the resource, `_read` should
876+
When \_read is called, if data is available from the resource, `_read` should
877877
start pushing that data into the read queue by calling `this.push(dataChunk)`.
878878
`_read` should continue reading from the resource and pushing data until push
879879
returns false, at which point it should stop reading from the resource. Only
880-
when _read is called again after it has stopped should it start reading
880+
when \_read is called again after it has stopped should it start reading
881881
more data from the resource and pushing that data onto the queue.
882882

883883
Note: once the `_read()` method is called, it will not be called again until

0 commit comments

Comments
 (0)
Please sign in to comment.