On 8/13/2013 7:42 AM, Edward K. Ream wrote:
On Mon, Aug 12, 2013 at 2:31 PM, Jacob Peck <[email protected]
<mailto:[email protected]>> wrote:
So please put the docs where someone naive (and we will all be
naive two weeks after reading about them) can find them. Thanks.
Will do, as soon as I can figure out where a good place would be.
Perhaps leo/doc/writingPlugins.txt?
By far the best place to put documentation for a plugin is in the
plugin's docstring. That way people will see it in the plugins menu
when the plugin is enabled.
Any other place will be harder for people to find. Having said that,
the expected place to read about plugins is in the "Plugins" Chapter,
http://leoeditor.com/plugins.html, *not* the "Writing Plugins"
Chapter, http://leoeditor.com/writingPlugins.html.
Edward
Well, the docs I'm discussing (adding the new plugin to the readthedocs
source) are only really for plugin writers. They're nothing that a user
would ever have to worry about. The plugin's docstring is read in by
readthedocs, but it doesn't know about it unless the plugin writer tells
readthedocs about it!
-->Jake
--
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/groups/opt_out.
