diff options
| author | Lance Bragstad <lbragstad@gmail.com> | 2018-06-01 21:25:19 +0000 |
|---|---|---|
| committer | Lance Bragstad <lbragstad@gmail.com> | 2018-06-01 21:25:19 +0000 |
| commit | 0f31938dd720015444e03f0056c0cfc0e4b8e932 (patch) | |
| tree | 72894680980555a7ec97dec0339bab438519fdf9 /releasenotes | |
| parent | ba836f2d409ecab61103cf859446c12322f99952 (diff) | |
| download | oslo-policy-0f31938dd720015444e03f0056c0cfc0e4b8e932.tar.gz | |
Remove erroneous newline in sample generation
The sample generation code for policies has a couple different cases
that make sure deprecated rules have descriptions and reasoning
formatted in the comment section. One of the cases that handles
policies deprecated for removal was injecting an extra newline in the
comment text that threw off the formatting of the sample, leaving
the subsequent policy uncommented, and visually unpleasing.
This commit removes the extra newline in the formatting logic for
deprecated policies and adds a test case for the behavior.
Change-Id: I76338d2fbaccf3b43e0da04732fd9df3c05dfbda
Closes-Bug: 1771442
Diffstat (limited to 'releasenotes')
| -rw-r--r-- | releasenotes/notes/fix-rendering-for-deprecated-rules-d465292e4155f483.yaml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/releasenotes/notes/fix-rendering-for-deprecated-rules-d465292e4155f483.yaml b/releasenotes/notes/fix-rendering-for-deprecated-rules-d465292e4155f483.yaml new file mode 100644 index 0000000..45b85b8 --- /dev/null +++ b/releasenotes/notes/fix-rendering-for-deprecated-rules-d465292e4155f483.yaml @@ -0,0 +1,6 @@ +--- +fixes: + - | + [`bug 1771442 <https://bugs.launchpad.net/oslo.policy/+bug/1771442>`_] + Policy rules that are deprecated for removal are now properly formatted + when rendering sample policy files for documentation. |