From a55eb1d80437349403ee423c28adf61b8804c1ff Mon Sep 17 00:00:00 2001 From: onerandomusername Date: Sun, 18 Jun 2023 16:30:35 -0400 Subject: [PATCH] docs: add links to version guarantees and whatsnew on both pages --- docs/version_guarantees.rst | 2 +- docs/whats_new.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/version_guarantees.rst b/docs/version_guarantees.rst index 9ce623fa32..103d4b6d8c 100644 --- a/docs/version_guarantees.rst +++ b/docs/version_guarantees.rst @@ -7,7 +7,7 @@ Version Guarantees This library does **not** quite follow the semantic versioning principle, the notable difference being that breaking changes may not only occur on major version increases, but also on minor version bumps (think Python's own versioning scheme). The primary reason for this is the lack of guarantees on the Discord API side when it comes to breaking changes, which along with the dynamic nature of the API results in breaking changes sometimes being required more frequently than desired. -However, any breaking changes will always be explicitly marked as such in the release notes. +However, any breaking changes will always be explicitly marked as such in the :ref:`whats_new`. In general, the versioning scheme (``major.minor.micro``) used in this library aims to follow these rules: diff --git a/docs/whats_new.rst b/docs/whats_new.rst index 427b7fe47c..d35c1c348a 100644 --- a/docs/whats_new.rst +++ b/docs/whats_new.rst @@ -11,7 +11,7 @@ Changelog ========= This page keeps a detailed human friendly rendering of what's new and changed -in specific versions. +in specific versions. Please see :ref:`version_guarantees` for more information. .. towncrier-draft-entries:: |release| [UNRELEASED]