Add explicit mention of word 'provisional' for version guarantee exclusions (#6311)

This commit is contained in:
Jakub Kuczys
2024-03-18 01:15:17 +01:00
committed by GitHub
parent 293d8065ec
commit 0c83fcd495
9 changed files with 29 additions and 19 deletions

View File

@@ -112,12 +112,18 @@ This allows us to add certain optional features non-breakingly without a name co
Any RPC method exposed by Red may break without notice.
Any exclusion from these guarantees should be noted in the documentation of
the affected attribute, function, class, or method.
If you would like something in here to be guaranteed,
open an issue making a case for it to be moved.
.. _developer-guarantees-exclusions:
Exclusions
----------
Any exclusion from these guarantees should be noted in the documentation of
the affected attribute, function, class, or method. The term "provisional"
may be used in documentation to note such exclusions.
.. _breaking-change-notices:
=======================