Skip to content

Commit

Permalink
Adding explaination to release docs (#1696)
Browse files Browse the repository at this point in the history
  • Loading branch information
john-science authored Apr 30, 2024
1 parent 7b26f79 commit dd19c73
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion doc/developer/tooling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,8 @@ minor PRs won't require a release note.
In particular, in the release notes, you will find four sections in the releasee notes:

1. **New Features** - A new feature (or major addition to a current feature) was added to the code.
2. **API Changes** - ANY change to the public-facing API of ARMI.
2. **API Changes** - ANY breaking change to the public-facing API of ARMI. (A breaking change is
when you change the existing API, not when you add something new to the API.)
3. **Bug Fixes** - ANY bug fix in the code (not the documentation), no matter how minor.
4. **Changes that Affect Requirements** - If you touch the code (``impl``) or test (``test``) for
anything that currently has a requirement crumb. (This must be a non-trivial change.)
Expand Down
4 changes: 2 additions & 2 deletions doc/release/0.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Release Date: TBD

New Features
------------
#. Conserve mass by component in assembly.setBlockMesh(). (`PR#1665 <https://github.com/terrapower/armi/pull/1665>`_)
#. Removal of the Block.reactor property. (`PR#1425 <https://github.com/terrapower/armi/pull/1425>`_)
#. Conserve mass by component in ``assembly.setBlockMesh()``. (`PR#1665 <https://github.com/terrapower/armi/pull/1665>`_)
#. Removal of the ``Block.reactor`` property. (`PR#1425 <https://github.com/terrapower/armi/pull/1425>`_)
#. System information is now also logged on Linux. (`PR#1689 <https://github.com/terrapower/armi/pull/1689>`_)
#. TBD

Expand Down

0 comments on commit dd19c73

Please sign in to comment.