Minor docs update
This commit is contained in:
parent
c17dde3bcc
commit
dc25ae2d3e
|
@ -81,3 +81,12 @@ rpc with ``rpc_``.
|
||||||
Since only basic types (like string, integer, dict, etc) can be passed over
|
Since only basic types (like string, integer, dict, etc) can be passed over
|
||||||
RPC, a well-written module should have helper rpc methods to express and
|
RPC, a well-written module should have helper rpc methods to express and
|
||||||
manipulate the module's state using only these types.
|
manipulate the module's state using only these types.
|
||||||
|
|
||||||
|
Using the RPC client in python code is very easy. The above shows how to use
|
||||||
|
RPC methods using python; rpc clients can be created as so:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
from pyircbot.rpcclient import connect
|
||||||
|
rpc = connect("127.0.0.1", 1876)
|
||||||
|
|
|
@ -158,7 +158,7 @@ class BotRPC(Thread):
|
||||||
return (True, "Var set")
|
return (True, "Var set")
|
||||||
|
|
||||||
def quit(self, message):
|
def quit(self, message):
|
||||||
"""Tell the bot to quit IRC and exir
|
"""Tell the bot to quit IRC and exit
|
||||||
|
|
||||||
:param message: Quit message
|
:param message: Quit message
|
||||||
:type moduleName: str"""
|
:type moduleName: str"""
|
||||||
|
|
Loading…
Reference in New Issue