CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Add information about provisional status of RPC (#3862)

Browse Source
This commit is contained in:
Neuro Assassin 2020-05-25 15:26:46 -04:00 committed by GitHub
parent e52ff98cad
commit 87d828a1b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/framework_rpc.rst
View File

@ -4,6 +4,10 @@
RPC 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.
V3 comes default with an internal RPC server that may be used to remotely control the bot in various ways. 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. Cogs must register functions to be exposed to RPC clients.
Each of those functions must only take JSON serializable parameters and must return JSON serializable objects. Each of those functions must only take JSON serializable parameters and must return JSON serializable objects.

2
docs/version_guarantees.rst
View File

@ -20,6 +20,8 @@ which is not private (even if not documented) should not break without notice.
Anything in the ``redbot.cogs`` module or any of it's submodules is specifically Anything in the ``redbot.cogs`` module or any of it's submodules is specifically
excluded from being guaranteed. excluded from being guaranteed.
Any RPC method exposed by Red may break without notice.
If you would like something in here to be guaranteed, If you would like something in here to be guaranteed,
open an issue making a case for it to be moved. open an issue making a case for it to be moved.

6
redbot/core/rpc.py
View File

@ -127,6 +127,9 @@ class RPCMixin:
All parameters to RPC handler methods must be JSON serializable objects. All parameters to RPC handler methods must be JSON serializable objects.
The return value of handler methods must also be JSON serializable. 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.
Parameters Parameters
---------- ----------
method : coroutine method : coroutine
@ -148,6 +151,9 @@ class RPCMixin:
This will be called automatically for you on cog unload and will pass silently if the This will be called automatically for you on cog unload and will pass silently if the
method is not previously registered. 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.
Parameters Parameters
---------- ----------
method : coroutine method : coroutine