GNOME Bugzilla – Bug 321623
procedural.py needs some high-level documentation aimed at end-users
Last modified: 2011-02-07 06:01:20 UTC
Currently if a new user tries using Dogtail's procedural API there isn't much indication of how to use it: the source code itself does so many tricks that it's difficult to read, and the inline API docs are at a low-level. Proposal: (i) have a high-level description of how to use the API aimed at people who've never seen Dogtail before, giving example script fragments etc in the top-level comment in the procedural.py file, so that it shows up in the generated documentation. (ii) regenerate the docs on the website, and provide a link to this in the main website's docs page.
I'll get on (i). (ii) may be more frustrating. I just haven't found a sane HTML documentation generator yet. :/
If you haven't already, check out epydoc. Here's an example API Docs for one of the core modules of GRAMPS: http://developers.gramps-project.org/devdoc/api/public/RelLib-module.html
dogtail development has been stalled and it has been unmaintained for a few years now. Maintainers don't have future development plan so i am closing bugs as WONTFIX. Please feel free to reopen the bugs in future if anyone takes the responsibility for active development.