Skip to content

Commit 3a2fcd4

Browse files
committed
Capitalize YAML and RST
Capitalizing these helps to distinguish between the yaml/rst format and file extension.
1 parent 14b315d commit 3a2fcd4

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/docsite/rst/community/development_process.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ We build short summary changelogs for minor releases as well as for major releas
7878
Creating a changelog fragment
7979
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8080

81-
A basic changelog fragment is a ``.yaml`` or ``.yml`` file placed in the ``changelogs/fragments/`` directory. Each file contains a yaml dict with keys like ``bugfixes`` or ``major_changes`` followed by a list of changelog entries of bugfixes or features. Each changelog entry is written in the `rst <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html>`_ format and embedded in the yaml file. This means that certain constructs need to be escaped so that they can be interpreted by rst and not by yaml (or escaped for both yaml and rst if you prefer). Each PR **must** use a new fragment file rather than adding to an existing one, so we can trace the change back to the PR that introduced it.
81+
A basic changelog fragment is a ``.yaml`` or ``.yml`` file placed in the ``changelogs/fragments/`` directory. Each file contains a YAML dict with keys like ``bugfixes`` or ``major_changes`` followed by a list of changelog entries of bugfixes or features. Each changelog entry is written in the `RST <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html>`_ format and embedded in the YAML file. This means that certain constructs need to be escaped so that they can be interpreted by RST and not by YAML (or escaped for both YAML and RST if you prefer). Each PR **must** use a new fragment file rather than adding to an existing one, so we can trace the change back to the PR that introduced it.
8282

8383
PRs which add a new module or plugin do not necessarily need a changelog fragment. See the previous section :ref:`community_changelogs`. Also see the next section :ref:`changelogs_how_to_format` for the precise format changelog fragments should have.
8484

0 commit comments

Comments
 (0)