mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-12-07 18:02:31 -05:00
Add explicit mention of word 'provisional' for version guarantee exclusions (#6311)
This commit is contained in:
@@ -66,7 +66,7 @@ Help Functionality
|
||||
|
||||
.. warning::
|
||||
|
||||
The content in this section is provisional and may change
|
||||
The content in this section is `provisional <developer-guarantees-exclusions>` and may change
|
||||
without prior notice or warning. Updates to this will be communicated
|
||||
on `this issue <https://github.com/Cog-Creators/Red-DiscordBot/issues/4084>`_
|
||||
|
||||
|
||||
@@ -6,7 +6,8 @@ RPC
|
||||
|
||||
.. important::
|
||||
|
||||
RPC support is included in Red on a provisional basis. Backwards incompatible changes (up to and including removal of the RPC) may occur if deemed necessary.
|
||||
RPC support is included in Red on a `provisional <developer-guarantees-exclusions>` basis.
|
||||
Backwards incompatible changes (up to and including removal of the RPC) may occur if deemed necessary.
|
||||
|
||||
V3 comes default with an internal RPC server that may be used to remotely control the bot in various ways.
|
||||
Cogs must register functions to be exposed to RPC clients.
|
||||
|
||||
@@ -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:
|
||||
|
||||
=======================
|
||||
|
||||
Reference in New Issue
Block a user