Skip to content

Docs whatsnew enumerated lists #3970

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tkknight merged 4 commits into from
Jan 31, 2021
Merged

Docs whatsnew enumerated lists #3970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0c079bf
use enumerated lists in whatsnew
bjlittle Jan 28, 2021
07e2d67
add enumerated list for latest template
bjlittle Jan 28, 2021
6340176
enumerate patch dropdown
bjlittle Jan 28, 2021
21b200e
review actions
bjlittle Jan 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 11 additions & 13 deletions docs/iris/src/developers_guide/documenting/whats_new_contributions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,15 @@ what's new document.
The appropriate contribution for a pull request might in fact be an addition or
change to an existing "What's New" entry.

Each contribution will ideally be written as a single concise bullet point
in a reStructuredText format. Where possible do not exceed **column 80** and
ensure that any subsequent lines of the same bullet point are aligned with the
first. The content should target an Iris user as the audience. The required
content, in order, is as follows:
Each contribution will ideally be written as a single concise entry using a
reStructuredText auto-enumerated list ``#.`` directive. Where possible do not
exceed **column 80** and ensure that any subsequent lines of the same entry are
aligned with the first. The content should target an Iris user as the audience.
The required content, in order, is as follows:

* Names of those who contributed the change. These should be their GitHub
user name. Link the name to their GitHub profile. E.g.
```@bjlittle <https://github.com/bjlittle>`_ and
`@tkknight <https://github.com/tkknight>`_ changed...``
```@tkknight <https://github.com/tkknight>`_ changed...``

* The new/changed behaviour

Expand All @@ -79,15 +78,14 @@ content, in order, is as follows:
* Pull request references, bracketed, following the final period. E.g.
``(:pull:`1111`, :pull:`9999`)``

* A trailing blank line (standard reStructuredText bullet format)
* A trailing blank line (standard reStructuredText list format)

For example::

* `@bjlittle <https://github.com/bjlittle>`_ and
`@tkknight <https://github.com/tkknight>`_ changed changed argument ``x``
to be optional in :class:`~iris.module.class` and
:meth:`iris.module.method`. This allows greater flexibility as requested in
:issue:`9999`. (:pull:`1111`, :pull:`9999`)
#. `@tkknight <https://github.com/tkknight>`_ changed changed argument ``x``
to be optional in :class:`~iris.module.class` and
:meth:`iris.module.method`. This allows greater flexibility as requested in
:issue:`9999`. (:pull:`1111`, :pull:`9999`)


The above example also demonstrates some of the possible syntax for including
Expand Down
Loading