Author: damoxc
Revision: 5212
Log:
add a doc string
Diff:
Modified: trunk/deluge/ui/web/json_api.py
===================================================================
--- trunk/deluge/ui/web/json_api.py 2009-04-28 09:09:08 UTC (rev 5211)
+++ trunk/deluge/ui/web/json_api.py 2009-04-28 15:59:56 UTC (rev 5212)
@@ -361,7 +361,14 @@
d.callback(file_tree.get_tree())
@export
- def get_torrent_files(self, torrent_id):
+ def get_torrent_files(self, torrent_id):
+ """
+ Gets the files for a torrent in tree format
+
+ :param torrent_id: string, the id of the torrent to retrieve.
+ :returns: The torrents files in a tree
+ :rtype: dict
+ """
main_deferred = Deferred()
d = client.core.get_torrent_status(torrent_id, FILES_KEYS)
d.addCallback(self._on_got_files, main_deferred)
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"deluge-commit" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/deluge-commit?hl=en
-~----------~----~----~----~------~----~------~--~---
