r274 - in /debtorrent/branches/unique: DebTorrent/BT1/FileSelector.py DebTorrent/SocketHandler.py docs/epydoc.config hippy.py uniquely.py
camrdale-guest at users.alioth.debian.org
camrdale-guest at users.alioth.debian.org
Sun Aug 19 23:28:15 UTC 2007
Author: camrdale-guest
Date: Sun Aug 19 23:28:15 2007
New Revision: 274
URL: http://svn.debian.org/wsvn/debtorrent/?sc=1&rev=274
Log:
Fix some documentation errors.
Modified:
debtorrent/branches/unique/DebTorrent/BT1/FileSelector.py
debtorrent/branches/unique/DebTorrent/SocketHandler.py
debtorrent/branches/unique/docs/epydoc.config
debtorrent/branches/unique/hippy.py
debtorrent/branches/unique/uniquely.py
Modified: debtorrent/branches/unique/DebTorrent/BT1/FileSelector.py
URL: http://svn.debian.org/wsvn/debtorrent/debtorrent/branches/unique/DebTorrent/BT1/FileSelector.py?rev=274&op=diff
==============================================================================
--- debtorrent/branches/unique/DebTorrent/BT1/FileSelector.py (original)
+++ debtorrent/branches/unique/DebTorrent/BT1/FileSelector.py Sun Aug 19 23:28:15 2007
@@ -143,8 +143,8 @@
def init_priorities(self, init_priority):
"""Initialize the priorities of all the files from the unpickled state.
- @type new_priority: C{list} of C{int}
- @param new_priority: the new file priorities
+ @type init_priority: C{list} of C{int}
+ @param init_priority: the new file priorities
@rtype: C{boolean}
@return: whether the initialization was successful
Modified: debtorrent/branches/unique/DebTorrent/SocketHandler.py
URL: http://svn.debian.org/wsvn/debtorrent/debtorrent/branches/unique/DebTorrent/SocketHandler.py?rev=274&op=diff
==============================================================================
--- debtorrent/branches/unique/DebTorrent/SocketHandler.py (original)
+++ debtorrent/branches/unique/DebTorrent/SocketHandler.py Sun Aug 19 23:28:15 2007
@@ -65,9 +65,9 @@
@param sock: the socket to manage
@type handler: unknown
@param handler: the handler to use for all communications on the socket
- @type ip: C{string}
- @param ip: the IP address to use if one can't be obtained from the socket
- (optional, defaults to 'unknown')
+ @type dns: (C{string}, C{int})
+ @param dns: the IP address and port to use if one can't be obtained
+ from the socket (optional, defaults to 'unknown')
"""
Modified: debtorrent/branches/unique/docs/epydoc.config
URL: http://svn.debian.org/wsvn/debtorrent/debtorrent/branches/unique/docs/epydoc.config?rev=274&op=diff
==============================================================================
--- debtorrent/branches/unique/docs/epydoc.config (original)
+++ debtorrent/branches/unique/docs/epydoc.config Sun Aug 19 23:28:15 2007
@@ -1,9 +1,9 @@
[epydoc] # Epydoc section marker (required by ConfigParser)
-# The list of objects to document. Objects can be named using
+# The list of objects to document. Objects can be named using
# dotted names, module filenames, or package directory names.
# Alases for this option include "objects" and "values".
-modules: DebTorrent btcompletedir.py btcopyannounce.py btmakemetafile.py btreannounce.py btrename.py btsetdebmirrors.py btshowmetainfo.py debtorrent-client.py debtorrent-tracker.py
+modules: DebTorrent btcompletedir.py btcopyannounce.py btmakemetafile.py btreannounce.py btrename.py btsetdebmirrors.py btshowmetainfo.py debtorrent-client.py debtorrent-tracker.py hippy.py uniquely.py
# The type of output that should be generated. Should be one
# of: html, text, latex, dvi, ps, pdf.
Modified: debtorrent/branches/unique/hippy.py
URL: http://svn.debian.org/wsvn/debtorrent/debtorrent/branches/unique/hippy.py?rev=274&op=diff
==============================================================================
--- debtorrent/branches/unique/hippy.py (original)
+++ debtorrent/branches/unique/hippy.py Sun Aug 19 23:28:15 2007
@@ -28,7 +28,7 @@
def read_release(filename):
"""Read the headers and Packages file names from a Release file.
- @type filename: C[string}
+ @type filename: C{string}
@param filename: the Release file to read
@rtype: C{dictionary}, C{list} of C{string}
@return: the headers and full file names of Packages files
@@ -253,7 +253,7 @@
def get_packages(filename):
"""Read the new piece data from a Packages file.
- @type filename: C[string}
+ @type filename: C{string}
@param filename: the Packages file to open and parse
@rtype: C{list} of C{string}
@return: the package files listed in the Packages file
@@ -290,7 +290,7 @@
@type cache: C{bsddb.BTree}
@param cache: an already opened bDB b-tree
- @type releasefile: C[string}
+ @type releasefile: C{string}
@param releasefile: the Release file to process
"""
Modified: debtorrent/branches/unique/uniquely.py
URL: http://svn.debian.org/wsvn/debtorrent/debtorrent/branches/unique/uniquely.py?rev=274&op=diff
==============================================================================
--- debtorrent/branches/unique/uniquely.py (original)
+++ debtorrent/branches/unique/uniquely.py Sun Aug 19 23:28:15 2007
@@ -33,7 +33,7 @@
def read_release(filename):
"""Read the headers and Packages file names from a Release file.
- @type filename: C[string}
+ @type filename: C{string}
@param filename: the Release file to read
@rtype: C{dictionary}, C{list} of C{string}
@return: the headers and full file names of Packages files
@@ -81,7 +81,7 @@
def get_old(old_file):
"""Read the headers and piece ordering data from an old file.
- @type old_file: C[string}
+ @type old_file: C{string}
@param old_file: the old piece ordering file to open
@rtype: C{dictionary}, C{dictionary}
@return: the old piece ordering (keys are the file names, values are the
@@ -189,7 +189,7 @@
piece ordering. This is done by modifying the input old_all_files,
all_pieces, and all_new_pieces variables.
- @type filename: C[string}
+ @type filename: C{string}
@param filename: the Packages file to open and parse
@type old_files: C{dictionary}
@param old_files: the original piece ordering, keys are the file names,
@@ -301,7 +301,7 @@
def write_file(filename, pieces, headers):
"""Print the new data to the file.
- @type filename: C[string}
+ @type filename: C{string}
@param filename: the file to write to
@type pieces: C{dictionary}
@param pieces: the current piece ordering, keys are the starting piece
@@ -331,7 +331,7 @@
def run(releasefile):
"""Process a single Release file.
- @type releasefile: C[string}
+ @type releasefile: C{string}
@param releasefile: the Release file to process
"""
More information about the Debtorrent-commits
mailing list