On Sat, Jan 8, 2011 at 8:21 AM, Terry Brown <[email protected]> wrote: > On Sat, 8 Jan 2011 07:50:36 -0600 > Kent Tenney <[email protected]> wrote: > >> Could there be some sort of capability index for plugins? > > I was trying to head in that direction with the docstring extraction stuff, > the first step was automated docstring extraction, the next step structured > information in the docstring which could be extracted for such an index. > What it does, with a summary line and some domain tags (text manipulation, > PIM, database, network, format, document generation etc. etc.) being the most > important part, but also fields such as status, last updated, GUI > compatibility, etc. > > So the plugin docstrings are now collected here: > > http://webpages.charter.net/edreamleo/plugins.html > > To start the ball rolling on structured information in the docstring, I'd > propose the rst field list syntax for putting things in the docstrings, so > the docstring for contextmenu.py, for example, might be: > > """ > Defines various useful actions for context menus (Qt only). > > :tags: enabled by default, qt only, has api > :status: working 20110105 > :updated: 201008
should it be formal: - controlled fields - controlled tags are multi-word tags a good idea if they will be used for search and retrieve? or should it be ad-hoc fields and tags? How much help does Sphinx provide in indexing the fields? Are there Sphinx constructs to put in the docstring which would add value automagically? Thanks, Kent > > Examples are: > > - Edit in $EDITOR > etc. etc. > """ > > ok - that was a bad choice because that's an odd plugin, really functionality > you'd think of as core, but it still illustrates. > > Then it's just a matter of extracting the tags etc. at > http://webpages.charter.net/edreamleo/plugins.html > > Cheers -Terry > > -- > You received this message because you are subscribed to the Google Groups > "leo-editor" group. > To post to this group, send email to [email protected]. > To unsubscribe from this group, send email to > [email protected]. > For more options, visit this group at > http://groups.google.com/group/leo-editor?hl=en. > > -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/leo-editor?hl=en.
