Skip to content

Commit

Permalink
Changelog: add note about backward-incompatible changes
Browse files Browse the repository at this point in the history
  • Loading branch information
brechtm committed Sep 15, 2022
1 parent 2d21b11 commit 5de15f0
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
Release History
---------------

.. note:: rinohtype uses `Semantic Versioning`__ for its releases. In summary,
this means that each release gets a version number MAJOR.MINOR.PATCH. The
MAJOR version number is increased when backwards-incompatible API changes
are made. However, until we exit beta and reach version 1.0.0, anything may
change at any time.

With this in mind, to ease upgrading from a previous version, I try to
explicitly list backward-incompatible changes in the *Changed* section for
each release. Be sure to check these when upgrading.

.. __: https://semver.org/


Release 0.5.5 (in development)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

New Features:

* Enumerated list item labels now also respect the *number_separator* style
property, enabling hierarchical list item labels.
property, enabling hierarchical list item labels (discussion #350).
* Admonitions now have a 'custom_title_text' property that can be used to
style generic admonitions. For example, this style definition applies to
``.. admonition:: Fun Fact``::
Expand Down

0 comments on commit 5de15f0

Please sign in to comment.