From ecf9822ac05c1d23b3454f75a156b05a5b08c1d2 Mon Sep 17 00:00:00 2001 From: Calum Lind Date: Tue, 15 Nov 2016 10:33:52 +0000 Subject: [Docs] Fix example and param notation in reST docstrings * For future parsing into other docstring styles. --- deluge/common.py | 11 +++++------ deluge/config.py | 7 ------- deluge/ui/web/auth.py | 6 +++--- deluge/ui/web/json_api.py | 6 +++--- deluge/ui/web/server.py | 10 +++++----- 5 files changed, 16 insertions(+), 24 deletions(-) diff --git a/deluge/common.py b/deluge/common.py index d15d5e270..c27fc1dfb 100644 --- a/deluge/common.py +++ b/deluge/common.py @@ -317,7 +317,6 @@ def fsize(fsize_b, precision=1, shortform=False): str: A formatted string in KiB, MiB or GiB units. Examples: - >>> fsize(112245) '109.6 KiB' >>> fsize(112245, precision=0) @@ -554,7 +553,7 @@ def is_url(url): :returns: True or False :rtype: bool - **Usage** + :Example: >>> is_url('http://deluge-torrent.org') True @@ -586,7 +585,7 @@ def is_magnet(uri): :returns: True or False :rtype: bool - **Usage** + :Example: >>> is_magnet('magnet:?xt=urn:btih:SU5225URMTUEQLDXQWRB2EQWN6KLTYKN') True @@ -730,7 +729,7 @@ def is_ip(ip): :returns: True or False :rtype: bool - ** Usage ** + :Example: >>> is_ip('127.0.0.1') True @@ -769,7 +768,7 @@ def decode_string(s, encoding='utf8'): :param s: string to decode :type s: string - :keyword encoding: the encoding to use in the decoding + :param encoding: the encoding to use in the decoding :type encoding: string :returns: s converted to unicode :rtype: unicode @@ -802,7 +801,7 @@ def utf8_encoded(s, encoding='utf8'): :param s: (unicode) string to (re-)encode :type s: basestring - :keyword encoding: the encoding to use in the decoding + :param encoding: the encoding to use in the decoding :type encoding: string :returns: a utf8 encoded string of s :rtype: str diff --git a/deluge/config.py b/deluge/config.py index 44ee1d2ca..ae96201ca 100644 --- a/deluge/config.py +++ b/deluge/config.py @@ -165,7 +165,6 @@ class Config(object): currently in the config and it could not convert the value. Examples: - >>> config = Config('test.conf') >>> config['test'] = 5 >>> config['test'] @@ -239,7 +238,6 @@ class Config(object): ValueError: If 'key' is not in the config dictionary. Examples: - >>> config = Config('test.conf', defaults={'test': 5}) >>> config['test'] 5 @@ -267,7 +265,6 @@ class Config(object): any: The value of item 'key' or default. Examples: - >>> config = Config('test.conf', defaults={'test': 5}) >>> config.get('test', 10) 5 @@ -297,7 +294,6 @@ class Config(object): ValueError: If 'key' is not in the config dictionary. Examples: - >>> config = Config('test.conf', defaults={'test': 5}) >>> del config['test'] @@ -323,7 +319,6 @@ class Config(object): callback (func): The function to call with parameters: f(key, value). Examples: - >>> config = Config('test.conf', defaults={'test': 5}) >>> def cb(key, value): ... print key, value @@ -342,7 +337,6 @@ class Config(object): apply_now (bool): If True, the function will be called immediately after it's registered. Examples: - >>> config = Config('test.conf', defaults={'test': 5}) >>> def cb(key, value): ... print key, value @@ -366,7 +360,6 @@ class Config(object): """Calls all set functions. Examples: - >>> config = Config('test.conf', defaults={'test': 5}) >>> def cb(key, value): ... print key, value 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'): -- cgit