codex-storage/deluge
1
0
Fork 0
mirror of https://github.com/codex-storage/deluge.git synced 2025-01-28 20:25:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix docstring errors raised by spinx docs build

Browse Source
This commit is contained in:
Calum Lind 2014-09-20 19:53:04 +01:00
parent 6b7df9ca08
commit 9a801b4b93
2 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
deluge/core/torrentmanager.py
View File

@ -80,9 +80,10 @@ class TorrentManagerState:
class TorrentManager(component.Component): class TorrentManager(component.Component):
"""TorrentManager contains a list of torrents in the current libtorrent """TorrentManager contains a list of torrents in the current libtorrent session.
session. This object is also responsible for saving the state of the
session for use on restart. This object is also responsible for saving the state of the session for use on restart.
""" """
def __init__(self): def __init__(self):
@ -726,7 +727,8 @@ class TorrentManager(component.Component):
Returns: Returns:
t.i.d.DeferredList: A list of twisted Deferred callbacks that will t.i.d.DeferredList: A list of twisted Deferred callbacks that will
be invoked when save is complete. be invoked when save is complete.
""" """
if torrent_ids is None: if torrent_ids is None:
torrent_ids = (t[0] for t in self.torrents.iteritems() if t[1].handle.need_save_resume_data()) torrent_ids = (t[0] for t in self.torrents.iteritems() if t[1].handle.need_save_resume_data())
@ -1170,7 +1172,9 @@ class TorrentManager(component.Component):
def on_alert_file_completed(self, alert): def on_alert_file_completed(self, alert):
"""Alert handler for libtorrent file_completed_alert """Alert handler for libtorrent file_completed_alert
Emits a TorrentFileCompletedEvent when an individual file completes downloading Emits a TorrentFileCompletedEvent when an individual file completes downloading
""" """
log.debug("file_completed_alert: %s", decode_string(alert.message())) log.debug("file_completed_alert: %s", decode_string(alert.message()))
try: try:
@ -1182,8 +1186,10 @@ class TorrentManager(component.Component):
def on_alert_state_update(self, alert): def on_alert_state_update(self, alert):
"""Alert handler for libtorrent state_update_alert """Alert handler for libtorrent state_update_alert
Result of a session.post_torrent_updates() call and contains the torrent status Result of a session.post_torrent_updates() call and contains the torrent status
of all torrents that changed since last time this was posted. of all torrents that changed since last time this was posted.
""" """
log.debug("on_status_notification: %s", alert.message()) log.debug("on_status_notification: %s", alert.message())
self.last_state_update_alert_ts = time.time() self.last_state_update_alert_ts = time.time()

4
deluge/ui/web/json_api.py
View File

@ -727,10 +727,10 @@ class WebApi(JSONComponent):
Add torrents by file Add torrents by file
:param torrents: A list of dictionaries containing the torrent \ :param torrents: A list of dictionaries containing the torrent \
path and torrent options to add with. path and torrent options to add with.
:type torrents: list :type torrents: list
**Usage** ::
json_api.web.add_torrents([{ json_api.web.add_torrents([{
"path": "/tmp/deluge-web/some-torrent-file.torrent", "path": "/tmp/deluge-web/some-torrent-file.torrent",