mirrors/deluge
0
0
Fork 0
mirror of https://git.deluge-torrent.org/deluge synced 2025-08-06 16:38:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update some docstrings

Browse source
This commit is contained in:
Andrew Resch 2009-07-23 04:23:41 +00:00
commit fbaa8db003
1 changed files with 18 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

25
deluge/core/core.py
View file

@ -240,11 +240,15 @@ class Core(component.Component):
""" """
Adds a torrent file to the session. Adds a torrent file to the session.
:param filename: str, the filename of the torrent :param filename: the filename of the torrent
:param filedump: str, a base64 encoded string of the torrent file contents :type filename: string
:param options: dict, the options to apply to the torrent on add :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 :returns: the torrent_id as a str or None
:rtype: string
""" """
try: try:
@ -299,8 +303,13 @@ class Core(component.Component):
""" """
Adds a torrent from a magnet link. Adds a torrent from a magnet link.
:param uri: str, the magnet link :param uri: the magnet link
:param options: dict, the options to apply to the torrent on add :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) log.debug("Attempting to add by magnet uri: %s", uri)
@ -346,7 +355,8 @@ class Core(component.Component):
""" """
Gets the session status values for 'keys' 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, ...} :returns: a dictionary of {key: value, ...}
:rtype: dict :rtype: dict
@ -363,7 +373,8 @@ class Core(component.Component):
""" """
Returns a dictionary of the session's cache status. Returns a dictionary of the session's cache status.
:returns: a dict of the cache status :returns: the cache status
:rtype: dict
""" """