From 5c30c619898b1c0ff0d93b7e2cc05d6586f8e4e5 Mon Sep 17 00:00:00 2001 From: Morgan Fainberg Date: Fri, 14 Dec 2018 07:20:44 -0800 Subject: [PATCH] Add note about boilerplate content Provide guidance in the template to remove the boilerplate text. Many specs have much of the boiler plate remaining including the description of how to use the spec template. The boilerplate content should not be left in specs. Change-Id: I974764f1534efd0530517bd74a52a5a5b70b898f --- specs/template.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/specs/template.rst b/specs/template.rst index 80f1118e..5a622063 100644 --- a/specs/template.rst +++ b/specs/template.rst @@ -10,7 +10,6 @@ Example Spec - The title of your blueprint `bug #XXXXXXX `_ - Introduction paragraph -- why are we doing anything? A single paragraph of prose that operators can understand. @@ -46,6 +45,9 @@ Some notes about using this template: * Do not delete any of the sections in this template. If you have nothing to say for a whole section, just write: None + Note that the boilerplate text should be replaced with real text or + ``None``. + * To test out your formatting, build the docs using tox, or see: http://rst.ninjs.org