diff options
author | Calum Lind <calumlind+deluge@gmail.com> | 2016-11-15 10:33:52 +0000 |
---|---|---|
committer | Calum Lind <calumlind+deluge@gmail.com> | 2016-11-17 12:33:23 +0000 |
commit | ecf9822ac05c1d23b3454f75a156b05a5b08c1d2 (patch) | |
tree | c90ac3bea4f25bd03d5409eab371b9225e2d94bd /deluge/ui | |
parent | c1249a2f3a1d64319f2da73ccdb94d9caaba722f (diff) | |
download | deluge-ecf9822ac05c1d23b3454f75a156b05a5b08c1d2.tar.gz deluge-ecf9822ac05c1d23b3454f75a156b05a5b08c1d2.tar.bz2 deluge-ecf9822ac05c1d23b3454f75a156b05a5b08c1d2.zip |
[Docs] Fix example and param notation in reST docstrings
* For future parsing into other docstring styles.
Diffstat (limited to 'deluge/ui')
-rw-r--r-- | deluge/ui/web/auth.py | 6 | ||||
-rw-r--r-- | deluge/ui/web/json_api.py | 6 | ||||
-rw-r--r-- | deluge/ui/web/server.py | 10 |
3 files changed, 11 insertions, 11 deletions
diff --git a/deluge/ui/web/auth.py b/deluge/ui/web/auth.py index cc4350752..765d93e48 100644 --- a/deluge/ui/web/auth.py +++ b/deluge/ui/web/auth.py @@ -108,7 +108,7 @@ class Auth(JSONComponent): """ Creates a new session. - :keyword login: the username of the user logging in, currently \ + :param login: the username of the user logging in, currently \ only for future use currently. :type login: string """ @@ -194,9 +194,9 @@ class Auth(JSONComponent): :param request: The HTTP request in question :type request: twisted.web.http.Request - :keyword method: Check the specified method + :param method: Check the specified method :type method: function - :keyword level: Check the specified auth level + :param level: Check the specified auth level :type level: integer :raises: Exception diff --git a/deluge/ui/web/json_api.py b/deluge/ui/web/json_api.py index 5b967b11b..150a68bbb 100644 --- a/deluge/ui/web/json_api.py +++ b/deluge/ui/web/json_api.py @@ -52,7 +52,7 @@ def export(auth_level=AUTH_LEVEL_DEFAULT): :param func: the function to export :type func: function - :keyword auth_level: the auth level required to call this method + :param auth_level: the auth level required to call this method :type auth_level: int """ @@ -830,9 +830,9 @@ class WebApi(JSONComponent): :type host: string :param port: the port :type port: int - :keyword username: the username to login as + :param username: the username to login as :type username: string - :keyword password: the password to login with + :param password: the password to login with :type password: string """ diff --git a/deluge/ui/web/server.py b/deluge/ui/web/server.py index fcc39ad42..3f206215d 100644 --- a/deluge/ui/web/server.py +++ b/deluge/ui/web/server.py @@ -270,7 +270,7 @@ class ScriptResource(resource.Resource, component.Component): :type path: string :param filepath: The physical location of the script :type filepath: string - :keyword script_type: The type of script to add (normal, debug, dev) + :param script_type: The type of script to add (normal, debug, dev) :param script_type: string """ if script_type not in ('dev', 'debug', 'normal'): @@ -289,9 +289,9 @@ class ScriptResource(resource.Resource, component.Component): :type path: string :param filepath: The physical location of the script :type filepath: string - :keyword script_type: The type of script to add (normal, debug, dev) + :param script_type: The type of script to add (normal, debug, dev) :param script_type: string - :keyword recurse: Whether or not to recurse into other folders + :param recurse: Whether or not to recurse into other folders :param recurse: bool """ if script_type not in ('dev', 'debug', 'normal'): @@ -308,7 +308,7 @@ class ScriptResource(resource.Resource, component.Component): :param path: The path of the folder :type path: string - :keyword script_type: The type of script to add (normal, debug, dev) + :param script_type: The type of script to add (normal, debug, dev) :param script_type: string """ if script_type not in ('dev', 'debug', 'normal'): @@ -322,7 +322,7 @@ class ScriptResource(resource.Resource, component.Component): Returns a list of the scripts that can be used for producing script tags. - :keyword script_type: The type of scripts to get (normal, debug, dev) + :param script_type: The type of scripts to get (normal, debug, dev) :param script_type: string """ if script_type not in ('dev', 'debug', 'normal'): |