Author: damoxc
Revision: 5397
Log:
improve the docstring for the add_torrents method
Diff:
Modified: trunk/deluge/ui/web/json_api.py
===================================================================
--- trunk/deluge/ui/web/json_api.py 2009-06-17 19:07:30 UTC (rev 5396)
+++ trunk/deluge/ui/web/json_api.py 2009-06-18 08:25:14 UTC (rev 5397)
@@ -474,8 +474,15 @@
"""
Add torrents by file
- :param torrents: dict, 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.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"])
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
