On Fri, Oct 14, 2011 at 10:36 AM, Terry Brown <[email protected]> wrote:
> What I think we need is an agreed upon format for comments (usually > python doc. strings but not always) which can be spidered by some > script which makes a keyword searchable index for finding things. Imo, the simplest thing that could possibly work is the **only** thing that could possibly work :-) And docstrings are it. We could add keywords to docstrings to keywords, and (hey! Aha!) even write a script that complains about missing keywords, but that's about it. I have no patience for grand schemes involving "standards". Nobody ever follows them :-) > The top of .../leo/doc/plugin_catalog.py has > > Extract plugin status and docs. from docstrings > > :last_update: 20100301 > :plugin_status: inital development > :gui: qt and tk > :maintainer: [email protected] Excellent. And, haha, I found it in LeoDocs.leo. I am tempted to say that making this an @button node would make it more visible, but recent experience refutes this idea: a few days ago I wrote an @button script to check settings, and guess what I found when I filed the script under the "Buttons" heading? You guessed it, an older version of same, quite visible in the buttons bar. Sheesh, this is a hard problem :-) > Also, as I said elsewhere, I think we should unify all plugin docs in > the docstring, have them present on the web as well as in Leo, and > allow images to be used in both places. I agree completely. This "simplest thing" will give us at least 80% of everything we want concerning plugins. Hmm. A new thought. What about a print-buttons command which would, like the to-be-improved print-bindings/commands/settings, create a tree describing (or maybe even containing) all @button nodes (and maybe @@button nodes) "everywhere", whatever that means :-) Edward -- 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.
