[py-svn] r36366 - in py/dist/py/documentation: . future

[hpk at codespeak.net]

Author: hpk
Date: Tue Jan  9 16:20:44 2007
New Revision: 36366

Modified:
   py/dist/py/documentation/TODO.txt
   py/dist/py/documentation/future/planning.txt
Log:
some reorganisation and new tasks 


Modified: py/dist/py/documentation/TODO.txt
==============================================================================
--- py/dist/py/documentation/TODO.txt	(original)
+++ py/dist/py/documentation/TODO.txt	Tue Jan  9 16:20:44 2007
@@ -1,26 +1,61 @@
 Things to do before 0.9.0 
 ========================= 
 
+
+py.compat 
+-------------
+
+* (cfbolz) needs py/documentation/compat.txt 
+
+* (cfbolz) reimport/check python 2.4.4 modules 
+
 review all py lib documentation
 -------------------------------------
 
+* rename py/documentation to py/doc
+  (check web page and pypy usage of it)
+
 streamline exported API 
 -------------------------------------
 
 * (hpk, should be done) move not-to-be-exported Gateway() methods to _ - methods. 
 * docstrings  for all exported API
 
+* remove: 
+  test.compat.TestCAse 
+ 
+* remove from public namespace: 
+  py.test.Session / TerminalSession / RSession / LSession / TkinterSession
+  py.test.rest 
+  py.path.checker
+  XXX consider py.magic. invoke/revoke/patch/revert 
+ 
+* make "_" namespace:  
+  py.path.extpy -> py.path._extpy
+  py.log -> py._log (pypy!) 
+
+* review py.io and write py.io.dupfile docstring
+
 packaging
 -------------------------------------
 
+* debian package for py lib 
+* 
+
 APIGEN / source viewer
 -------------------------------------
 
-* deploying all that is neccessary on codespeak.net 
-
-* (cfbolz, guido) writing the ReST directive, make it available
-  with eg py.__.misc.docutils.install_doclink(NAME, urlbase ...) 
-  in a tested way. call the install from e.g. py/documentation/conftest.py 
+* make py.test --apigen=PATH_TO_SCRIPT 
+  collect tracing information and call the apigen 
+  script to produce api and source code documentation
+
+* deploy the above "py.test --apigen" run on codespeak 
+  regularly, determine good locations and a good 
+  directory and URL scheme . 
+
+* integrate rest directive into py/documentation/conftest.py 
+  with help code from py.__.rest.directive.... 
+  make sure that py/documentation/ *.txt files 
 
 testing
 -----------
@@ -46,9 +81,10 @@
 * move RSync class to py.execnet.RSync, document its usage and
   features in the class and method docstrings
 
+code quality
+-----------------
 
-other
--------
+* no function implementation longer than 30 lines 
 
 * no lines longer than 80 characters 
 
@@ -71,11 +107,6 @@
 
 * document py.test's conftest.py approach (somewhat done) 
 
-* put Armin's collect class into py.__builtin__ (not done) 
-
-* try get rid of Collect.tryiter() in favour of (not done)
-  using Armin's collect class 
-
 * hide py.test.TerminalSession and TkinterSession?  (questionable) 
 
 

Modified: py/dist/py/documentation/future/planning.txt
==============================================================================
--- py/dist/py/documentation/future/planning.txt	(original)
+++ py/dist/py/documentation/future/planning.txt	Tue Jan  9 16:20:44 2007
@@ -59,4 +59,8 @@
  * sets.py, subprocess.py in compat
  * fix -k option to py.test
  * add --report=(text|terminal|session|rest|tkinter|rest) to py.test
+ * put Armin's collect class into py.__builtin__ (not done) 
+ * try get rid of Collect.tryiter() in favour of (not done)
+   using Armin's collect class 
+