develooper Front page | perl.perl6.language | Postings from July 2005

Re: Documentation trait / Docstring equiverlent

Thread Previous | Thread Next
John Williams
July 2, 2005 09:17
Re: Documentation trait / Docstring equiverlent
Message ID:
On Thu, 30 Jun 2005, chromatic wrote:
> On Thu, 2005-06-30 at 04:33 +0000, David Formosa (aka ? the Platypus)
> wrote:
> > I'm just wondering if a documentation trait on subs would be usefull.
> > If we are going to have something like p6explain the doc trait could
> > be used as the source for the infomation for it.  p6explain would
> > simply have to walk the AST reading the doc traits and pasting the
> > text together.
> I certainly hope so.  Given Larry's recent work with the Perl 5
> tokenizer to include this information in the optree, it's a shame for
> Perl 6 to throw away potentially useful data recklessly.

There is something to be said for actually _organizing_ the documentation
too, which is why POD docs for a function are not always next to the
function itself.

That said, I hope the documentation trait on subs can optionally be a
pointer to the (section of the POD) document where the documentation
actually resides.

~ John Williams

Thread Previous | Thread Next Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About