Jason Tackaberry wrote: > On Tue, 2008-10-07 at 20:27 +0200, Hans Meine wrote: >> other people, too. I wonder if kaa.base's async stuff is (or could be) used >> other contexts (other python projects), too. Maybe one should announce it >> e.g. on python-dev? > > I use kaa.base all the time for personal stuff. kaa.base is certainly > well suited for any kind of Python project. There's nothing media- or > freevo- specific in there.
The idea behind kaa-* is not to have anything Freevo specific in it. > In fact, at work I've held an intro to python workshop, and intend to do > a second workshop where I go over more advanced concepts where I plan on > using kaa.base to show the kinds of benefits you get from a framework, > the power of decorators, and specifically coroutines. I'm very proud of our coroutines and the thread integration. It is very easy to put long tasks in a thread and "wait" for them in the main loop. > Before formally posting to a list like python-announce, the docs and > examples need a lot of cleanup. :) Basically everything in the wiki > belongs in either method or module docstrings. We still have a lot of > epydoc formatting work to do. Yes. I guess module docstrings are the important part. Hans Meine wrote: > I see. BTW: Nowadays, all projects (python itself, numpy, scipy, > ipython, ...) start using sphinx and nose, looks like they become standard > and maybe all of kaa's documentation (including the discussed SourceDoc) > could be shipped and maintained in SVN? I could have incorporated the > changes I proposed to Dischi directly, but while I am familiar with reST, I > actually dislike Wikis (and the associated accounts, logins,...). I guess a Wiki is good for user docs like Freevo itself. But the source doc is only edited by developers, so sphinx may be a good idea. But we should NOT drop in-code documentation because it is very nice to have when you want to fix or update something. Looking at beacon there is a doc for the API user and for the beacon developer. There are many functions in beacon that should not be part of the API doc but if someone wants to hack inside beacon it is needed. So here is my suggestion: 1. Write docstrings in the code with basic information like what the function does and what the parameters do. 2. Use sphinx as new tutorial and move the wiki stuff to reST based doc in svn. From time to time we should generate html from the reST doc using sphinx and update the web page. Dischi -- Drugs cause amnesia and other things I can't remember... ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ Freevo-devel mailing list Freevo-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freevo-devel
