diff options
| author | Brian Dolbec <brian.dolbec@gmail.com> | 2010-07-15 17:52:54 -0700 |
|---|---|---|
| committer | Brian Dolbec <brian.dolbec@gmail.com> | 2011-02-11 02:49:14 -0800 |
| commit | 5609d5d6f73b4e15477a4851c1f9701866b5a3c2 (patch) | |
| tree | 46f2683eaa43637ac5586ac56428ecbf02c9edc5 | |
| parent | 63789af9d74191578d21159f0b19af524134eb9f (diff) | |
| download | layman-5609d5d6f73b4e15477a4851c1f9701866b5a3c2.tar.gz layman-5609d5d6f73b4e15477a4851c1f9701866b5a3c2.tar.bz2 layman-5609d5d6f73b4e15477a4851c1f9701866b5a3c2.zip | |
fix the docstrings to match current input types.
| -rw-r--r-- | layman/api.py | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/layman/api.py b/layman/api.py index e3db37a..b6ff86a 100644 --- a/layman/api.py +++ b/layman/api.py @@ -99,8 +99,8 @@ class LaymanAPI(object): def delete_repo(self, repos): """delete the selected repo from the system - @type repos: list - @param repos: ['repo-id1', ...] + @type repos: list of strings or string + @param repos: ['repo-id1', ...] or 'repo-id' @param output: method to handle output if desired @rtype dict """ @@ -130,8 +130,8 @@ class LaymanAPI(object): def add_repo(self, repos): """installs the seleted repo id - @type repos: list - @param repos: ['repo-id1', ...] + @type repos: list of strings or string + @param repos: ['repo-id1', ...] or 'repo-id' @param output: method to handle output if desired @rtype dict """ @@ -161,8 +161,8 @@ class LaymanAPI(object): def get_info(self, repos): """retirves the recorded information about the repo specified by id - @type repos: list - @param repos: ['repo-id1', ...] + @type repos: list of strings or string + @param repos: ['repo-id1', ...] or 'repo-id' @rtype list of tuples [(str, bool, bool),...] @return: dictionary {'id': (info, official, supported)} """ @@ -191,7 +191,7 @@ class LaymanAPI(object): def sync(self, repos, output_results=True): """syncs the specified repo(s) specified by repos - @type repos: list or string + @type repos: list of strings or string @param repos: ['repo-id1', ...] or 'repo-id' @rtype bool or {'repo-id': bool,...} """ |