oslo.policy/fix-rendering-for-deprecated-rules-d465292e4155f483.yaml at ae842848804c148e107d5abddacee0f24371f0af - oslo.policy - OpenDev: Free Software Needs Free Tools

openstack/oslo.policy

Lance Bragstad 0f31938dd7 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

2018-06-01 21:25:19 +00:00

7 lines

226 B

YAML

Raw Blame History

 ---
 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.