I hope everyone is aware that you can now get Epydocs for Chandler really easily for all platforms:
./release/RunPython tools/gen_docs.py This will place the documents in docs folder. docs/api contains Epydoc documents, doc/model the repository object documentation. The latter is still incomplete (regression), but Epydoc should be complete. If you notice things missing from Epydoc, please fix and/or file bug(s). (Hmm, just noticed that the online versions seem to be really sparse, but my local copies seem to contain everything.) Currently we don't really document module, class and instance variables. I think this is because most don't know how (or even if it is possible) to do it. Well, there is a way. And I think it is REALLY useful to document the variables because just by looking at the code you may not even notice the variables (and if you do, you may not understand what it is supposed to hold). So, Epydoc does provide a way. See http://epydoc.sourceforge.net/fields.html variables section. In short: @var documents module variables, @cvar class variables and @ivar instance variables. To see an example, take a look at ssl.py: http://lxr.osafoundation.org/source/chandler/parcels/osaf/framework/certstore/ssl.py (it only does module variables, but it is straight forward for class and instance variables). A thing to note is that we run Epydoc so that it only documents public stuff. Everything that begins with _ (underscore) is considered private. Also, if you use __all__, anything not mentioned in there is considered private and will be skipped. -- Heikki Toivonen
signature.asc
Description: OpenPGP digital signature
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ Open Source Applications Foundation "Dev" mailing list http://lists.osafoundation.org/mailman/listinfo/dev
