mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-21 18:27:59 -05:00
[V3 Docs] Add and update existing features (#1451)
* [V3 Docs] bump version * Remove removed functions from __all__ * Update docstring format * Update copyright year * Add embed utils docs * Document bot class * Document RPC * Update toctree
This commit is contained in:
@@ -35,7 +35,9 @@ def add_topic(topic_name: str):
|
||||
"""
|
||||
Adds a topic for clients to listen to.
|
||||
|
||||
:param topic_name:
|
||||
Parameters
|
||||
----------
|
||||
topic_name
|
||||
"""
|
||||
_rpc.add_topics(topic_name)
|
||||
|
||||
@@ -50,8 +52,10 @@ def notify(topic_name: str, data: JsonSerializable):
|
||||
|
||||
This method will fail silently.
|
||||
|
||||
:param topic_name:
|
||||
:param data:
|
||||
Parameters
|
||||
----------
|
||||
topic_name
|
||||
data
|
||||
"""
|
||||
_rpc.notify(topic_name, data)
|
||||
|
||||
@@ -67,10 +71,11 @@ def add_method(prefix, method):
|
||||
|
||||
This method will fail silently.
|
||||
|
||||
:param prefix:
|
||||
:param method:
|
||||
Parameters
|
||||
----------
|
||||
prefix
|
||||
method
|
||||
MUST BE A COROUTINE OR OBJECT.
|
||||
:return:
|
||||
"""
|
||||
_rpc.add_methods(
|
||||
('', method),
|
||||
|
||||
Reference in New Issue
Block a user