Skip to content

Commit

Permalink
Wrap text at 119 chars
Browse files Browse the repository at this point in the history
  • Loading branch information
ItsDrike committed Jun 24, 2023
1 parent 189a3b4 commit 435f7c7
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions docs/pages/version_guarantees.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,13 @@ Version Guarantees
followed! This means that **breaking changes can occur in minor version bumps**, though micro version bumps are
still strictly for bugfixes, and will not include any features or breaking changes.

This library follows `semantic versioning model <https:semver.org>`_, which means the major version
is updated every time there is an incompatible (breaking) change made to the public API. However
due to the fairly dynamic nature of Python, it can be hard to discern what can be considered a
breaking change, and what isn't.

First thing to keep in mind is that breaking changes only apply to **publicly documented
functions and classes**. If it's not listed in the documentation here, it's an internal feature,
that isn't considered a part of the public API, and thus is bound to change. This includes
documented attributes that start with an underscore.
This library follows `semantic versioning model <https:semver.org>`_, which means the major version is updated every
time there is an incompatible (breaking) change made to the public API. However due to the fairly dynamic nature of
Python, it can be hard to discern what can be considered a breaking change, and what isn't.

First thing to keep in mind is that breaking changes only apply to **publicly documented functions and classes**. If
it's not listed in the documentation here, it's an internal feature, that isn't considered a part of the public API,
and thus is bound to change. This includes documented attributes that start with an underscore.

.. note::
The examples below are non-exhaustive.
Expand Down

0 comments on commit 435f7c7

Please sign in to comment.