Author: andar
Revision: 5540
Log:
Update some docstrings
Diff:
Modified: trunk/deluge/core/core.py
===================================================================
--- trunk/deluge/core/core.py 2009-07-23 04:14:08 UTC (rev 5539)
+++ trunk/deluge/core/core.py 2009-07-23 04:23:41 UTC (rev 5540)
@@ -240,11 +240,15 @@
"""
Adds a torrent file to the session.
- :param filename: str, the filename of the torrent
- :param filedump: str, a base64 encoded string of the torrent file
contents
- :param options: dict, the options to apply to the torrent on add
+ :param filename: the filename of the torrent
+ :type filename: string
+ :param filedump: a base64 encoded string of the torrent file contents
+ :type filedump: string
+ :param options: the options to apply to the torrent on add
+ :type options: dict
:returns: the torrent_id as a str or None
+ :rtype: string
"""
try:
@@ -299,8 +303,13 @@
"""
Adds a torrent from a magnet link.
- :param uri: str, the magnet link
- :param options: dict, the options to apply to the torrent on add
+ :param uri: the magnet link
+ :type uri: string
+ :param options: the options to apply to the torrent on add
+ :type options: dict
+
+ :returns: the torrent_id
+ :rtype: string
"""
log.debug("Attempting to add by magnet uri: %s", uri)
@@ -346,7 +355,8 @@
"""
Gets the session status values for 'keys'
- :param keys: list of strings, the keys for which we want values
+ :param keys: the keys for which we want values
+ :type keys: list
:returns: a dictionary of {key: value, ...}
:rtype: dict
@@ -363,7 +373,8 @@
"""
Returns a dictionary of the session's cache status.
- :returns: a dict of the cache status
+ :returns: the cache status
+ :rtype: dict
"""
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
