[or-cvs] r15295: Fix up pydoc string to fit in 80 columns. (torflow/branches/gsoc2008/TorCtl)

[mikeperry at seul.org]

Author: mikeperry
Date: 2008-06-15 21:48:02 -0400 (Sun, 15 Jun 2008)
New Revision: 15295

Modified:
   torflow/branches/gsoc2008/TorCtl/PathSupport.py
Log:

Fix up pydoc string to fit in 80 columns.



Modified: torflow/branches/gsoc2008/TorCtl/PathSupport.py
===================================================================
--- torflow/branches/gsoc2008/TorCtl/PathSupport.py	2008-06-16 01:42:10 UTC (rev 15294)
+++ torflow/branches/gsoc2008/TorCtl/PathSupport.py	2008-06-16 01:48:02 UTC (rev 15295)
@@ -537,16 +537,20 @@
 
 class BwWeightedGenerator(NodeGenerator):
   """
-  This is a generator designed to match the Tor Path Selection algorithm. It
-  will generate nodes weighted by their bandwidth, but take the appropriate
-  weighting into account against guard nodes and exit nodes when they are 
-  chosen for positions other than guard/exit. For background see: 
+
+  This is a generator designed to match the Tor Path Selection
+  algorithm.  It will generate nodes weighted by their bandwidth,
+  but take the appropriate weighting into account against guard
+  nodes and exit nodes when they are chosen for positions other
+  than guard/exit. For background see:
   routerlist.c::smartlist_choose_by_bandwidth(),
   http://archives.seul.org/or/dev/Jul-2007/msg00021.html,
   http://archives.seul.org/or/dev/Jul-2007/msg00056.html, and
   https://tor-svn.freehaven.net/svn/tor/trunk/doc/spec/path-spec.txt
-  The formulas used are from the first or-dev link, but are proven equivalent 
-  to the ones now used in routerlist.c in the second or-dev link
+  The formulas used are from the first or-dev link, but are proven
+  optimal and equivalent to the ones now used in routerlist.c in the 
+  second or-dev link.
+  
   """ 
   def __init__(self, sorted_r, rstr_list, pathlen, exit=False, guard=False):
     """ Pass exit=True to create a generator for exit-nodes """