Browse Source

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
Morgan Fainberg 4 months ago
parent
commit
5c30c61989
1 changed files with 3 additions and 1 deletions
  1. 3
    1
      specs/template.rst

+ 3
- 1
specs/template.rst View File

@@ -10,7 +10,6 @@ Example Spec - The title of your blueprint
10 10
 
11 11
 `bug #XXXXXXX <https://bugs.launchpad.net/keystone/+bug/XXXXXXX>`_
12 12
 
13
-
14 13
 Introduction paragraph -- why are we doing anything? A single paragraph of
15 14
 prose that operators can understand.
16 15
 
@@ -46,6 +45,9 @@ Some notes about using this template:
46 45
 * Do not delete any of the sections in this template.  If you have
47 46
   nothing to say for a whole section, just write: None
48 47
 
48
+  Note that the boilerplate text should be replaced with real text or
49
+  ``None``.
50
+
49 51
 * To test out your formatting, build the docs using tox, or see:
50 52
   http://rst.ninjs.org
51 53
 

Loading…
Cancel
Save