diff --git a/docs/pages/version_guarantees.rst b/docs/pages/version_guarantees.rst index f9868a33..d530fa86 100644 --- a/docs/pages/version_guarantees.rst +++ b/docs/pages/version_guarantees.rst @@ -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 `_, 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 `_, 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.