Skip to content

Commit

Permalink
docs: clarify how to use top-level notes
Browse files Browse the repository at this point in the history
Update new_fragment.md.j2

Update new_fragment.rst.j2

Update concepts.rst

Update new_fragment.rst.j2
  • Loading branch information
ncoghlan authored and nedbat committed Dec 21, 2024
1 parent ee0896a commit 18cb5f8
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 2 deletions.
5 changes: 4 additions & 1 deletion docs/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,11 @@ fragment, you provide your change information in the appropriate category.
When the fragments are collected, they are grouped by category into a single
changelog entry.

Any fragments that do not specify a category are included as top-level
release notes directly under the release heading.

You can choose not to use categories by setting the :ref:`config_categories`
setting to empty.
setting to empty (all notes will appear as top-level release notes).


.. _entries:
Expand Down
1 change: 1 addition & 0 deletions src/scriv/templates/new_fragment.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
A new scriv changelog fragment.
Uncomment the section that is right (remove the HTML comment wrapper).
For top level release notes, leave all the headers commented out.
-->

{% for cat in config.categories -%}
Expand Down
3 changes: 2 additions & 1 deletion src/scriv/templates/new_fragment.rst.j2
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.. A new scriv changelog fragment.
{% if config.categories -%}
..
.. Uncomment the header that is right (remove the leading dots).
.. Uncomment the section that is right (remove the leading dots).
.. For top level release notes, leave all the headers commented out.
..
{% for cat in config.categories -%}
.. {{ cat }}
Expand Down

0 comments on commit 18cb5f8

Please sign in to comment.