diff options
author | Calum Lind <calumlind@gmail.com> | 2018-10-08 14:22:49 +0100 |
---|---|---|
committer | Calum Lind <calumlind@gmail.com> | 2018-10-08 14:49:36 +0100 |
commit | 20fa106b8b746662cf1a884f8b2f8521a94efa68 (patch) | |
tree | 79544ea607471590a1451878176124911145d6d8 /docs | |
parent | 654e2af4e5f0e17b405c360e45846f4529555d3d (diff) | |
download | deluge-20fa106b8b746662cf1a884f8b2f8521a94efa68.tar.gz deluge-20fa106b8b746662cf1a884f8b2f8521a94efa68.tar.bz2 deluge-20fa106b8b746662cf1a884f8b2f8521a94efa68.zip |
Update pre-commit config
The prettier hook was missing a trailing slash so omitting css files.
Add a trailing space fix hook and fix issues.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/core/rpc.rst | 14 | ||||
-rw-r--r-- | docs/source/interfaces/web.rst | 4 |
2 files changed, 9 insertions, 9 deletions
diff --git a/docs/source/core/rpc.rst b/docs/source/core/rpc.rst index 90f553d0f..817e01571 100644 --- a/docs/source/core/rpc.rst +++ b/docs/source/core/rpc.rst @@ -5,9 +5,9 @@ Message Formats --------------- DelugeRPC is a protocol used for daemon/client communication. There are four types of messages involved in the protocol: RPC Request, RPC Response, -RPC Error and Event. All messages are zlib compressed rencoded strings and +RPC Error and Event. All messages are zlib compressed rencoded strings and their data formats are detailed below. - + """"""""""" RPC Request """"""""""" @@ -28,7 +28,7 @@ remote method be called. Multiple requests can be bundled in a list. call other objects or plugins methods. **args** (list) - The arguments to call the method with. + The arguments to call the method with. **kwargs** (dict) The keyword arguments to call the method with. @@ -38,7 +38,7 @@ RPC Response """""""""""" This message is created and sent in response to a RPC Request from a client. It will hold the return value of the requested method call. In the case of an -error, a RPC Error message will be sent instead. +error, a RPC Error message will be sent instead. **[message_type, request_id, [return_value]]** @@ -49,7 +49,7 @@ error, a RPC Error message will be sent instead. **request_id** (int) The request_id is the same as the one sent by the client in the initial request. It used on the client side to determine what message this is in - response to. + response to. **return_value** (list) The return value of the method call. @@ -58,7 +58,7 @@ error, a RPC Error message will be sent instead. RPC Error """"""""" This message is created in response to an error generated while processing a -RPC Request and will serve as a replacement for a RPC Response message. +RPC Request and will serve as a replacement for a RPC Response message. **[message_type, request_id, exception_type, exception_msg, traceback]** @@ -83,7 +83,7 @@ Event """"" This message is created by the daemon and sent to the clients without being in response to a RPC Request. Events are generally sent for changes in the -daemon's state that the clients need to be made aware of. +daemon's state that the clients need to be made aware of. **[message_type, event_name, data]** diff --git a/docs/source/interfaces/web.rst b/docs/source/interfaces/web.rst index 82cb3af2e..77e73195f 100644 --- a/docs/source/interfaces/web.rst +++ b/docs/source/interfaces/web.rst @@ -9,11 +9,11 @@ the ExtJS framework, running on top of a Twisted webserver. SSL Configuration ================= By default the web interface will use the same private key and certificate as -the Deluge daemon. If you wish to use a different certificate/key (see +the Deluge daemon. If you wish to use a different certificate/key (see `How to Create a SSL Certificate <http://www.yatblog.com/2007/02/27/how-to-create-a-ssl-certificate/>`_ for information on creating one) you are able to specify which you want to use. There are 2 ways to enable SSL encryption in the webserver, 1 is to specify it in your configuration (accessible via the Preferences window). The other is to add '--ssl' when running the webserver, which will override the configuration -value and enable SSL. +value and enable SSL. |