From bd26780e009440a11d6d81adc8c4f3d2dacb8160 Mon Sep 17 00:00:00 2001 From: Ben Noordhuis Date: Fri, 13 May 2016 23:24:33 +0200 Subject: [PATCH 1/2] build: add REPLACEME tag for version info in docs Add a `REPLACEME` tag that should be used when introducing docs for new features, so that they can be updated when releases are made. Ref: https://github.com/nodejs/node/issues/6578 --- Makefile | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Makefile b/Makefile index 488754b3f5d778..8ea13ba146d506 100644 --- a/Makefile +++ b/Makefile @@ -431,6 +431,10 @@ PACKAGEMAKER ?= /Developer/Applications/Utilities/PackageMaker.app/Contents/MacO PKGDIR=out/dist-osx release-only: + @if `grep -q REPLACEME doc/api/*.md`; then \ + echo 'Please update Added: tags in the documentation first.' ; \ + exit 1 ; \ + fi @if [ "$(shell git status --porcelain | egrep -v '^\?\? ')" = "" ]; then \ exit 0 ; \ else \ From d88af575e676f14b593e6f4b2966eca68794a780 Mon Sep 17 00:00:00 2001 From: Anna Henningsen Date: Thu, 19 May 2016 11:11:51 +0200 Subject: [PATCH 2/2] tools,doc: add example usage for REPLACEME tag --- tools/doc/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/tools/doc/README.md b/tools/doc/README.md index 22bd053ed1b058..1620d6c25acbc9 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) + + + * `x` {String} the description of the string + + This feature is not in a release yet. + ### Event: 'blerg'