codex-storage/deluge
1
0
Fork 0
mirror of https://github.com/codex-storage/deluge.git synced 2025-02-22 16:18:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

add autodoc for ui.common

Browse Source 
fix some docstrings in the json_api module
This commit is contained in:
Damien Churchill 2009-07-23 00:24:07 +00:00
parent 94891cb1f6
commit 5f89f5239e
2 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
deluge/ui/web/json_api.py
View File

@ -97,7 +97,7 @@ class JSONException(Exception):
class JSON(resource.Resource, component.Component):
"""
A Twisted Web resource that exposes a JSON-RPC interface for web clients
A Twisted Web resource that exposes a JSON-RPC interface for web clients \
to use.
"""
@ -469,14 +469,19 @@ class WebApi(JSONComponent):
:param filename: the path to the torrent
:type filename: string
:returns:
{
"filename": the torrent file
"name": the torrent name
"size": the total size of the torrent
"files": the files the torrent contains
"info_hash" the torrents info_hash
}
:returns: information about the torrent:
::
{
"filename": the torrent file,
"name": the torrent name,
"size": the total size of the torrent,
"files": the files the torrent contains,
"info_hash" the torrents info_hash
}
:rtype: dictionary
"""
d = Deferred()
@ -492,15 +497,17 @@ class WebApi(JSONComponent):
"""
Add torrents by file
:param torrents: A list of dictionaries containing the torrent
:param torrents: A list of dictionaries containing the torrent \
path and torrent options to add with.
:type torrents: list
**Usage**
>>> json_api.web.add_torrents([{
"path": "/tmp/deluge-web/some-torrent-file.torrent",
"options": {"download_path": "/home/deluge/"}
}])
"""
for torrent in torrents:
filename = os.path.basename(torrent["path"])

5
docs/source/modules/ui/common.rst Normal file
View File

@ -0,0 +1,5 @@
:mod:`deluge.ui.common`
====================
.. automodule:: deluge.ui.common
:members: