CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-12-05 17:02:32 -05:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

6
redbot/core/_rpc.py
View File

@@ -156,7 +156,8 @@ class RPCMixin:
The return value of handler methods must also be JSON serializable.
.. 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.
Parameters
----------
@@ -180,7 +181,8 @@ class RPCMixin:
method is not previously registered.
.. 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.
Parameters
----------

4
redbot/core/bot.py
View File

@@ -255,7 +255,7 @@ class Red(
Set's Red's help formatter.
.. warning::
This method is provisional.
This method is `provisional <developer-guarantees-exclusions>`.
The formatter must implement all methods in
@@ -296,7 +296,7 @@ class Red(
Resets Red's help formatter.
.. warning::
This method is provisional.
This method is `provisional <developer-guarantees-exclusions>`.
This exists for use in ``cog_unload`` for cogs which replace the formatter

2
redbot/core/commands/commands.py
View File

@@ -840,7 +840,7 @@ class CogMixin(CogGroupMixin, CogCommandMixin):
.. note::
This method is documented provisionally
This method is documented `provisionally <developer-guarantees-exclusions>`
and may have minor changes made to it.
It is not expected to undergo major changes,
but nothing utilizes this method yet and the inclusion of this method

5
redbot/core/commands/converter.py
View File

@@ -3,7 +3,8 @@ commands.converter
==================
This module contains useful functions and classes for command argument conversion.
Some of the converters within are included provisionally and are marked as such.
Some of the converters within are included `provisionally <developer-guarantees-exclusions>`
and are marked as such.
"""
import functools
import math
@@ -492,7 +493,7 @@ if not TYPE_CHECKING:
#: multiple types, but such usage is not supported and will fail at runtime
#:
#: .. warning::
#: This converter class is still provisional.
#: This converter class is still `provisional <developer-guarantees-exclusions>`.
UserInputOptional = Optional
if TYPE_CHECKING:

4
redbot/core/commands/help.py
View File

@@ -82,7 +82,7 @@ class HelpSettings:
.. warning::
This class is provisional.
This class is `provisional <developer-guarantees-exclusions>`.
"""
@@ -190,7 +190,7 @@ class HelpFormatterABC(abc.ABC):
.. warning::
This class is documented but provisional with expected changes.
This class is documented but `provisional <developer-guarantees-exclusions>` with expected changes.
In the future, this class will receive changes to support
invoking the help command without context.