FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: proper markdown escaping -> \_\_, \*, \_ · nodejs/node@611c2f6 · GitHub

/ node Public

Commit 611c2f6

Browse files
eljefedelrodeodeljefe
authored and
rvagg
committed
doc: proper markdown escaping -> \_\_, \*, \_
PR-URL: #4805 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
1 parent 5a860d9 commit 611c2f6

3 files changed

Lines changed: 13 additions & 13 deletions

File tree

‎doc/api/globals.markdown‎

Lines changed: 2 additions & 2 deletions
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

@@ -30,7 +30,7 @@ console.log(__dirname);
3030

3131
`__dirname` isn't actually a global but rather local to each module.
3232

33-
## __filename
33+
## \_\_filename
3434

3535
<!-- type=var -->
3636

‎doc/api/path.markdown‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ path.basename('/foo/bar/baz/asdf/quux.html', '.html')
2828

2929
The platform-specific path delimiter, `;` or `':'`.
3030

31-
An example on *nix:
31+
An example on \*nix:
3232

3333
```js
3434
console.log(process.env.PATH)
@@ -181,7 +181,7 @@ path.normalize('/foo/bar//baz/asdf/quux/..')
181181

182182
Returns an object from a path string.
183183

184-
An example on *nix:
184+
An example on \*nix:
185185

186186
```js
187187
path.parse('/home/user/dir/file.txt')
@@ -294,7 +294,7 @@ path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif')
294294

295295
The platform-specific file separator. `'\\'` or `'/'`.
296296

297-
An example on *nix:
297+
An example on \*nix:
298298

299299
```js
300300
'foo/bar/baz'.split(path.sep)

‎doc/api/stream.markdown‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -863,22 +863,22 @@ In classes that extend the Readable class, make sure to call the
863863
Readable constructor so that the buffering settings can be properly
864864
initialized.
865865

866-
#### readable._read(size)
866+
#### readable.\_read(size)
867867

868868
* `size` {Number} Number of bytes to read asynchronously
869869

870870
Note: **Implement this method, but do NOT call it directly.**
871871

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

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

884884
Note: once the `_read()` method is called, it will not be called again until
@@ -1127,7 +1127,7 @@ and Readable classes respectively. The `'finish'` event is fired after
11271127
`end` is fired after all data has been output which is after the callback
11281128
in `_flush` has been called.
11291129

1130-
#### transform._flush(callback)
1130+
#### transform.\_flush(callback)
11311131

11321132
* `callback` {Function} Call this function (optionally with an error
11331133
argument) when you are done flushing any remaining data.
@@ -1154,7 +1154,7 @@ the class that defines it, and should not be called directly by user
11541154
programs. However, you **are** expected to override this method in
11551155
your own extension classes.
11561156

1157-
#### transform._transform(chunk, encoding, callback)
1157+
#### transform.\_transform(chunk, encoding, callback)
11581158

11591159
* `chunk` {Buffer | String} The chunk to be transformed. Will **always**
11601160
be a buffer unless the `decodeStrings` option was set to `false`.
@@ -1309,7 +1309,7 @@ In classes that extend the Writable class, make sure to call the
13091309
constructor so that the buffering settings can be properly
13101310
initialized.
13111311

1312-
#### writable._write(chunk, encoding, callback)
1312+
#### writable.\_write(chunk, encoding, callback)
13131313

13141314
* `chunk` {Buffer | String} The chunk to be written. Will **always**
13151315
be a buffer unless the `decodeStrings` option was set to `false`.
@@ -1342,7 +1342,7 @@ the class that defines it, and should not be called directly by user
13421342
programs. However, you **are** expected to override this method in
13431343
your own extension classes.
13441344

1345-
#### writable._writev(chunks, callback)
1345+
#### writable.\_writev(chunks, callback)
13461346

13471347
* `chunks` {Array} The chunks to be written. Each chunk has following
13481348
format: `{ chunk: ..., encoding: ... }`.

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL