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

This commit is contained in:
Neuro Assassin
2020-05-25 15:26:46 -04:00
committed by GitHub
parent e52ff98cad
commit 87d828a1b0
3 changed files with 12 additions and 0 deletions

View File

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