Files
reno/releasenotes/notes/support-subsections-583600c47b3c7d49.yaml
Eric Arellano ee73c9409e Add support for subsections
Subsections will appear underneath their top-level section, in
the order defined in the config file. They will use a ^ or ~
underline rather than -.

Users define subsections by adding a number to the end
of the section entry, either 2 or 3. It will be a subsection
of the parent section above it. This syntax is simpler than others
considered, like nesting lists inside a top-level section. It also
makes it easy for us to support deeper levels of nesting if we'd like.

Like normal sections, in users' notes files, they will use the
ID they define for each subsection.

Change-Id: Ib7b4781de81e19d11a7acb863204067c0946827b
Story: 2010375
2023-03-07 13:56:39 -06:00

13 lines
554 B
YAML

---
features:
- |
Reno now allows specifying subsections, which will appear under
their top-level sections like "Features". This allows you to group
related changes together better.
To enable, set the ``sections`` value in config. Add subsections directly
underneath their top-level section, with the number ``2`` or ``3`` after
to indicate its nesting level. For example,
``["features_command_line", "Command Line", 2]``. Then, in your release note
files, use the ID of the subsection, e.g. ``features_command_line``.