diff --git a/docs/rpc/_rpc.rst b/docs/rpc/_rpc.rst index 2a693de..2b89993 100644 --- a/docs/rpc/_rpc.rst +++ b/docs/rpc/_rpc.rst @@ -81,3 +81,12 @@ rpc with ``rpc_``. 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 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) diff --git a/pyircbot/rpc.py b/pyircbot/rpc.py index e2f250c..8004053 100644 --- a/pyircbot/rpc.py +++ b/pyircbot/rpc.py @@ -158,7 +158,7 @@ class BotRPC(Thread): return (True, "Var set") def quit(self, message): - """Tell the bot to quit IRC and exir + """Tell the bot to quit IRC and exit :param message: Quit message :type moduleName: str"""