mirror of
https://git.deluge-torrent.org/deluge
synced 2025-04-21 03:54:50 +00:00
add a doc string
This commit is contained in:
parent
b4e56e923b
commit
96b38188fc
1 changed files with 8 additions and 1 deletions
|
@ -361,7 +361,14 @@ class WebApi(JSONComponent):
|
|||
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)
|
||||
|
|
Loading…
Add table
Reference in a new issue