openstack/reno
Code Issues Proposed changes

Make note template follow correct formatting

Browse Source 
The template used to create a new release note does not follow the ReST
standards[0]. This can be confusing to a contributor who may be
unfamiliar with the formatting requirements, as they will tend to follow
the template format, and end up with incorrect ReST. This patch adds the
required vertical bar and newline to each section.

[0] http://docs.openstack.org/developer/reno/usage.html#formatting

Change-Id: Ie8cbe524376a3c3e1e11446abdc6e5fa00233d51
This commit is contained in:
EdLeafe
2016-06-30 16:02:00 +00:00
parent 50c6ed36be
commit 2f89f7a0b0
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
reno/create.py
View File

@@ -32,56 +32,64 @@ prelude: >
major features or adding release theme details should
have a prelude.
features:
- List new features here, or remove this section.
- |
List new features here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
issues:
- List known issues here, or remove this section.
- |
List known issues here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
upgrade:
- List upgrade notes here, or remove this section.
- |
List upgrade notes here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
deprecations:
- List deprecations notes here, or remove this section.
- |
List deprecations notes here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
critical:
- Add critical notes here, or remove this section.
- |
Add critical notes here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
security:
- Add security notes here, or remove this section.
- |
Add security notes here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
fixes:
- Add normal bug fixes here, or remove this section.
- |
Add normal bug fixes here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
other:
- Add other notes here, or remove this section.
- |
Add other notes here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any