Re: Docstrings and interactive module help

[steve donovan <steve.j.donovan@...>]

On Thu, Mar 21, 2013 at 10:26 AM, Dirk Laurie <dirk.laurie@gmail.com> wrote:
>> On a slight tangent, it comes up occasionally [parenthetic opprobrious
>> personal remark deleted] that it would be very useful to have
>> interactive help for modules.

I'll never live that Python remark down ;)

> `help` makes an effort to find the source code. The present version
> wants the docstring to be inside the function, since for functions
> loaded by `load` that is the only place it can be. Maybe the maintainer
> of LuaDoc can meet me halfway:

I suspect the maintainers of LuaDoc have moved onto other things, and
in fact indicated that they were quite happy if LDoc was the
successor.  So being a kind of defacto maintainer, let's think about
this.

Note: 'exactly three hyphens' is wrong. The standard is 'at least
three hyphens' and if the first line only contains hyphens, it is
ignored and also indicates the start of the docstring.

steve d.