Author: andar
Revision: 5666
Log:
Fix some docstrings
Diff:
Modified: trunk/deluge/maketorrent.py
===================================================================
--- trunk/deluge/maketorrent.py 2009-08-12 21:18:39 UTC (rev 5665)
+++ trunk/deluge/maketorrent.py 2009-08-13 05:02:39 UTC (rev 5666)
@@ -57,7 +57,7 @@
"""
This class is used to create .torrent files.
- *** Usage ***
+ ** Usage **
>>> t = TorrentMetadata()
>>> t.data_path = "/tmp/torrent"
@@ -254,6 +254,7 @@
def set_piece_size(self, size):
"""
:param size: the desired piece size in bytes
+ :type size: int
:raises InvalidPieceSize: if the piece size is not a multiple of 16KiB
Modified: trunk/deluge/ui/gtkui/common.py
===================================================================
--- trunk/deluge/ui/gtkui/common.py 2009-08-12 21:18:39 UTC (rev 5665)
+++ trunk/deluge/ui/gtkui/common.py 2009-08-13 05:02:39 UTC (rev 5666)
@@ -128,9 +128,9 @@
def show_other_dialog(header, type_str, image_stockid=None,
image_filename=None, default=0):
"""
- Shows a dialog with :param:`header` as the header text and
:param:`type_str`
+ Shows a dialog with `header` as the header text and `type_str`
as the type text. The type of spinbutton (int or float) is determined by
- :param:`default`s type.
+ `default` type.
:param header: str, the header label text
:param type_str: str, the type label text, what comes after the spinbutton
@@ -138,11 +138,11 @@
:param image_filename: str, filename of icon in pixmaps folder
:param default: the default value in the spinbutton
- :returns: None, int or float from spinbutton depending on :param:`default`.
+ :returns: None, int or float from spinbutton depending on `default`.
None is returned if the user clicks on Cancel.
:rtype: None, int or float
- :raises TypeError: if :param:`default` is not of type int or float
+ :raises TypeError: if `default` is not of type int or float
"""
if type(default) != int and type(default) != float:
@@ -213,7 +213,7 @@
Returns the deluge icon for use in setting a dialogs icon. It will first
attempt to get the icon from the theme and will fallback to using an image
that is distributed with the package.
-
+
"""
if deluge.common.windows_check():
return get_logo(32)
@@ -223,4 +223,3 @@
return icon_theme.load_icon("deluge", 64, 0)
except:
return get_logo(64)
-
Modified: trunk/deluge/ui/gtkui/removetorrentdialog.py
===================================================================
--- trunk/deluge/ui/gtkui/removetorrentdialog.py 2009-08-12 21:18:39 UTC
(rev 5665)
+++ trunk/deluge/ui/gtkui/removetorrentdialog.py 2009-08-13 05:02:39 UTC
(rev 5666)
@@ -44,10 +44,11 @@
"""
This class is used to create and show a Remove Torrent Dialog.
- :param torrent_ids: a list of torrent_ids to remove
+ :param torrent_ids: the torrent_ids to remove
+ :type torrent_ids: list of torrent_ids
- :raises TypeError: if :param:`torrent_id` is not a sequence type
- :raises ValueError: if :param:`torrent_id` contains no torrent_ids or is
None
+ :raises TypeError: if `torrent_id` is not a sequence type
+ :raises ValueError: if `torrent_id` contains no torrent_ids or is None
"""
def __init__(self, torrent_ids):
Modified: trunk/docs/source/conf.py
===================================================================
--- trunk/docs/source/conf.py 2009-08-12 21:18:39 UTC (rev 5665)
+++ trunk/docs/source/conf.py 2009-08-13 05:02:39 UTC (rev 5666)
@@ -37,7 +37,7 @@
# General substitutions.
project = 'Deluge'
-copyright = '2008, Andrew Resch'
+copyright = '2008-2009, Deluge Team'
# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
@@ -159,7 +159,7 @@
# (source start file, target name, title, author, document class
[howto/manual]).
latex_documents = [
('index', 'deluge.tex', 'deluge Documentation',
- 'Andrew Resch', 'manual'),
+ 'Deluge Team', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
