dogtail-devel [Bug 321623] New: procedural.py needs some high-level documentation aimed at end-users

["dogtail (bugzilla.gnome.org)" <bugzilla-daemon bugzilla gnome org>]

Do not reply to this via email (we are currently unable to handle email
responses and they get discarded).  You can add comments to this bug at
http://bugzilla.gnome.org/show_bug.cgi?id=321623
 dogtail | Framework | Ver: CVS HEAD

           Summary: procedural.py needs some high-level documentation aimed
                    at end-users
           Product: dogtail
           Version: CVS HEAD
          Platform: Other
        OS/Version: Linux
            Status: UNCONFIRMED
          Severity: normal
          Priority: Normal
         Component: Framework
        AssignedTo: dogtail-maint gnome bugs
        ReportedBy: dmalcolm redhat com
         QAContact: dogtail-maint gnome bugs
                CC: all-bugs bugzilla gnome org


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.

------- You are receiving this mail because: -------
You are watching the assignee for the bug.
You are watching the QA contact.