summaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
authorAnna Henningsen <anna@addaleax.net>2016-05-19 11:11:51 +0200
committerEvan Lucas <evanlucas@me.com>2016-06-15 17:47:35 -0500
commit6562c9fc75e2bc44521198e893194d752c0b6dc5 (patch)
treef2d4c7426ae01b8b0a506d4a4817b9746e293389 /tools
parent666b6f9302700256a19dccb20d1e1839ad471013 (diff)
downloadnode-new-6562c9fc75e2bc44521198e893194d752c0b6dc5.tar.gz
tools,doc: add example usage for REPLACEME tag
Ref: https://github.com/nodejs/node/issues/6578 PR-URL: https://github.com/nodejs/node/pull/6864 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'tools')
-rw-r--r--tools/doc/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/tools/doc/README.md b/tools/doc/README.md
index 22bd053ed1..1620d6c25a 100644
--- a/tools/doc/README.md
+++ b/tools/doc/README.md
@@ -34,6 +34,15 @@ Each type of heading has a description block.
A description of the function.
+ ### module.someNewFunction(x)
+ <!-- YAML
+ added: REPLACEME
+ -->
+
+ * `x` {String} the description of the string
+
+ This feature is not in a release yet.
+
### Event: 'blerg'
<!-- YAML
added: v0.10.0