Skip to content

Commit

Permalink
update maintenance doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Remi-Gau committed Sep 27, 2023
1 parent 876b6a3 commit f9135e4
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,10 +146,11 @@ Prepare code for the release
The repository should be checked and updated in preparation for the release.

One thing that **must** be done before the release is made is
to update ``alldeprecated``, ``versionchanged`` and ``versionadded`` directives
to update ``deprecated``, ``versionchanged`` and ``versionadded`` directives
from the current ``[x.y.z].dev`` tag to the new version number.

Additionally, make sure all deprecations that are supposed to be removed with this new version have been addressed.

If this new release comes with dependency version bumps (Python, Numpy...), make sure to implement and test these changes beforehand.
Ideally, these would have been done before such as to update the code base if necessary.
Finally, make sure the documentation can be built correctly.
Expand Down

0 comments on commit f9135e4

Please sign in to comment.