Help-for-command provides the docstrings of alt-x commands, not the
plugins. So, /Alt-x global-search <enter>/ would give you the docstring
of global-search (if it had one defined).
Unfortunately, the docstrings are the only documentation for many (all?)
plugins, so the plugin authors really should touch that up.
-->Jake
On 9/19/2014 10:25 PM, lewis wrote:
Thanks for the quick fix.
I know you aren't the author of bigdash plugin (Ville I think) but
I've just been reminded of some usability aspects of some plugins in Leo.
With leo running the only documentation in Leo is via
Plugins>bigdash.py which displays:
Leo.plugins.bigdash
Global search window
To use full text search, you need to install Whoosh library
('easy_install Whoosh'). The fts_max_hits setting controls the maximum
hits returned.
This gives no information at all about how to use the plugin.
It should say enter Alt-x keys then type /global-search/ into the
Minibuffer
_or_ Type global-search directly into the Minibuffer
Also there is no listing of bigdash at http://leoeditor.com/plugins.html
Checked
http://leoeditor.com/writingPlugins.html#documenting-plugins for a
template guide.
I tried the _Help for Command (F11)_ in the Minibuffer but it returns
/bigdash.py no docstring available/
Even for the well documented plugin mod_http.py F11 only returns:
/mod_http.py /
/no docstring available /
So I'm not sure if the docstring does not exist or the _Help for
Command_ is not working?
Regards
Lewis
--
You received this message because you are subscribed to the Google
Groups "leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send
an email to [email protected]
<mailto:[email protected]>.
To post to this group, send email to [email protected]
<mailto:[email protected]>.
Visit this group at http://groups.google.com/group/leo-editor.
For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to the Google Groups
"leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/leo-editor.
For more options, visit https://groups.google.com/d/optout.
