SF.net SVN: fclient: [76] trunk/TODO.txt

[<jU...@us...>]

Revision: 76
          http://fclient.svn.sourceforge.net/fclient/?rev=76&view=rev
Author:   jUrner
Date:     2007-11-13 13:00:35 -0800 (Tue, 13 Nov 2007)

Log Message:
-----------
some more words

Modified Paths:
--------------
    trunk/TODO.txt

Modified: trunk/TODO.txt
===================================================================
--- trunk/TODO.txt	2007-11-13 20:59:47 UTC (rev 75)
+++ trunk/TODO.txt	2007-11-13 21:00:35 UTC (rev 76)
@@ -1,5 +1,33 @@
-Major todos
+Term efinitions
 ********************************************************************************************
+Fcp == Freenet Client Protocol
+
+
+Compatibility
+********************************************************************************************
+
+python >= 2.5
+Qt >= 4.3 (Qt and pyQt are still moving targets and compatibility to older versions nearly mpossible)
+
+
+
+Code
+********************************************************************************************
+
+indentation: Tabs. That is no spaces allowed for indentation.
+classes, consts: camel case
+method names: mixed case (Qt sets the standard here)
+docstrings: an undocumentd class, method, (...) is no class (...) at all.
+docstring markup: plain epydoc. No reSt allowed.
+tests: as many unittests as possible. Pretty hard to do unittests for Fcp. Anyone any ideas? 
+
+
+Yet one or the other part of the code has to be adjusted to follow these rules. 
+
+
+
+Major todos and thoughts
+********************************************************************************************
 x. fist widgets to implement: up / downloads, browser, message board
 	
 	Multipurpose up / downnload widget should be ready to go in relatively short time.
@@ -18,7 +46,7 @@
 	..and maybe more.
 	
 		
-x. quite a lot of consts are undocumented. Consts used in config settings for example.
+x. quite a lot of Fcp consts are undocumented. Consts used in config settings for example.
 	Or the string representations of consts describing the status of peers. The node
 	says hapily this peer is "CONNECTED". But couldn't find any info on the const, except 
 	tracking it down to the PEER_NODE_STATUS_CONNECTED const as defined in
@@ -27,8 +55,10 @@
 	
 x. a widget that can be used to visualize freenet index files. This thingy should give some header information 
 	and allow the user to select any number of uris from an index for download. Already implemented a half 
-	way working prototype. But quite unclear how to handle _massive_ indices reliably. Intersting
-	thing would be to allow for automized creation of index files from a bunch of files ready for
+	way working prototype. But quite unclear how to handle _massive_ indices reliably. Problem is index files
+	are Xml... nightmare to parse (hi, I am index and I am blowing up your machine on the next 3Gig CDATA string). 
+	
+	Interesting thing would be to allow for automized creation of index files from a bunch of files ready for
 	insertion (wizzard?).
 
 
@@ -41,7 +71,12 @@
 	[https://frogpie.svn.sourceforge.net/svnroot/frogpie/trunk/sandbox/chm].
 	Shouldn't be too hard to polish this package and add the desired functionality.
 	Basically its about adjusting the package to support output writers. Alternative
-	is to flesh "chm_lib/epydoc_fs.py" out and base a standalone module on it.  
+	is to flesh out "chm_lib/epydoc_fs.py" and base a standalone module on it.  
 
 
 
+
+
+
+
+


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.