Changeset 96b381

Timestamp:

04/28/2009 03:59:56 PM (16 years ago)

Author:

Damien Churchill <damoc@gmail.com>

Branches:

2.0.x, develop, extjs4-port, master

Children:

e856e6

Parents:

b4e56e

Message:

add a doc string

File:

• deluge/ui/web/json_api.py (modified) (1 diff)

deluge/ui/web/json_api.py

@@ -362 +362 @@
     
     @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)