Skip to content

Commit fb82ca5

Browse files
committed
DOC: Improve What's new entry description
1 parent b8ee229 commit fb82ca5

File tree

2 files changed

+20
-9
lines changed

2 files changed

+20
-9
lines changed

doc/api/next_api_changes/README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ A typical entry could look like this::
3939

4040
Please avoid using references in section titles, as it causes links to be
4141
confusing in the table of contents. Instead, ensure that a reference is
42-
included in the descriptive text.
42+
included in the descriptive text. Use inline literals (double backticks)
43+
to denote code objects in the title.
4344

4445
.. api-change-guide-end

doc/users/next_whats_new/README.rst

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,14 @@
99
1010
Instructions for writing "What's new" entries
1111
=============================================
12-
1312
.. whats-new-guide-start
1413
15-
Please place new portions of :file:`whats_new.rst` in the
16-
:file:`doc/users/next_whats_new/` directory.
14+
Each new feature (e.g. function, parameter, config value, behavior, ...) must
15+
be described through a "What's new" entry.
16+
17+
Each entry is written into a separate file in the
18+
:file:`doc/users/next_whats_new/` directory. They are sorted and merged into
19+
:file:`whats_new.rst` during the release process.
1720

1821
When adding an entry please look at the currently existing files to
1922
see if you can extend any of them. If you create a file, name it
@@ -26,14 +29,21 @@ Include contents of the form::
2629
Section title for feature
2730
-------------------------
2831

29-
A bunch of text about how awesome the new feature is and examples of how
30-
to use it.
32+
A description of the feature from the user perspective. This should include
33+
what the features allows them to do and how they can use it. Technical
34+
details should be left out if they are not relevant to the user.
35+
36+
The description may include a a short instructive example, if it helps to
37+
understand the feature.
3138

32-
A sub-section
33-
~~~~~~~~~~~~~
39+
Optional sub-section
40+
~~~~~~~~~~~~~~~~~~~~
41+
Typical whats-new entries are a single section, but you may add subsections
42+
if it makes sense.
3443

3544
Please avoid using references in section titles, as it causes links to be
3645
confusing in the table of contents. Instead, ensure that a reference is
37-
included in the descriptive text.
46+
included in the descriptive text. Use inline literals (double backticks)
47+
to denote code objects in the title.
3848

3949
.. whats-new-guide-end

0 commit comments

Comments
 (0)