From 0ca5a10d5e6398e6f881404ed6e5d557e68252ec Mon Sep 17 00:00:00 2001 From: Damien Churchill Date: Thu, 23 Jul 2009 00:46:23 +0000 Subject: [PATCH] Couple more tweaks to the docstrings --- deluge/ui/common.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/deluge/ui/common.py b/deluge/ui/common.py index f3b8d53f7..ad9176e9e 100644 --- a/deluge/ui/common.py +++ b/deluge/ui/common.py @@ -33,6 +33,11 @@ # # +""" +The ui common module contains methods and classes that are deemed useful for +all the interfaces. +""" + import os import sys import urlparse @@ -211,7 +216,8 @@ class FileTree(object): """ Convert a list of paths in a file tree. - :param paths: list, The paths to be converted. + :param paths: The paths to be converted. + :type paths: list """ def __init__(self, paths): @@ -286,7 +292,8 @@ def get_localhost_auth(): """ Grabs the localclient auth line from the 'auth' file and creates a localhost uri - :returns: tuple, with the username and password to login as + :returns: with the username and password to login as + :rtype: tuple """ auth_file = deluge.configmanager.get_config_dir("auth") if os.path.exists(auth_file):