Do a bunch more README work.

[dunshire.git] / TODO

diff --git a/TODO b/TODO
index ab87751f3168ceecdf739128a222dd766828c377..8b345c92084113dba5582073a3ccf48636243253 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,6 +1,7 @@
 1. Add unit testing for crazier things like random invertible matrices.
 
 1. Add unit testing for crazier things like random invertible matrices.
 

-2. Add real docstrings everywhere.
+2. Copy the intro from my thesis into README.rst, and add a section
+   explaining the CVXOPT formulation.

 
 3. Try to eliminate the code in matrices.py.
 
 
 3. Try to eliminate the code in matrices.py.
 


@@ -14,10 +15,13 @@
 
 7. Make sure we have the dimensions of the PSD cone correct.
 
 
 7. Make sure we have the dimensions of the PSD cone correct.
 

-8. Use a positive tolerance when comparing floating point numbers.
-
-9. Come up with a fast heuristic (like making nu huge and taking e1 as
+8. Come up with a fast heuristic (like making nu huge and taking e1 as

    our point) that finds a primal feasible point.
 
    our point) that finds a primal feasible point.
 

-10. Ensure that we only compute eigenvalues of *symmetric* matrices
-    (so that the eigenvalues are real).
+9. We only need to include the API docs for dunshire.games in the
+   "user manual;" everything else can go in an appendix.
+
+10. Enable doctesting of *.rst files (this might make the doctest
+    suite I'm already running redundant?) I should only need to test a
+    few specific ReST files and use the existing suite to test the API
+    docs.