summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2012-12-21 11:32:18 -0800
committerisaacs <i@izs.me>2012-12-21 11:32:29 -0800
commit982981442dc7b993b935f6db7c125415f4b433cc (patch)
tree83e8098fe2280d3235093908dcd42f1e856c060e
parentf119effc9f959dc1854dd8c95bf36009679429b1 (diff)
downloadnode-982981442dc7b993b935f6db7c125415f4b433cc.tar.gz
doc: Nudge formatting to make json generator happy
Starting a line with `**bold**` text makes it think that it's a link, and get confused. This should really be fixed properly in the doc generator, but for now, it's not a major issue. It's probably just a matter of updating marked.
-rw-r--r--doc/api/stream.markdown8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown
index 974c5dd22..b245f04b6 100644
--- a/doc/api/stream.markdown
+++ b/doc/api/stream.markdown
@@ -112,7 +112,7 @@ initialized.
All Readable stream implementations must provide a `_read` method
to fetch data from the underlying resource.
-**This function MUST NOT be called directly.** It should be
+Note: **This function MUST NOT be called directly.** It should be
implemented by child classes, and called by the internal Readable
class methods only.
@@ -296,7 +296,7 @@ initialized.
All Writable stream implementations must provide a `_write` method to
send data to the underlying resource.
-**This function MUST NOT be called directly.** It should be
+Note: **This function MUST NOT be called directly.** It should be
implemented by child classes, and called by the internal Writable
class methods only.
@@ -432,7 +432,7 @@ initialized.
All Transform stream implementations must provide a `_transform`
method to accept input and produce output.
-**This function MUST NOT be called directly.** It should be
+Note: **This function MUST NOT be called directly.** It should be
implemented by child classes, and called by the internal Transform
class methods only.
@@ -458,7 +458,7 @@ your own extension classes.
* `callback` {Function} Call this function (optionally with an error
argument) when you are done flushing any remaining data.
-**This function MUST NOT be called directly.** It MAY be implemented
+Note: **This function MUST NOT be called directly.** It MAY be implemented
by child classes, and if so, will be called by the internal Transform
class methods only.