[OPEN-ILS-DEV] Code Documentation Proposal

[Andrew Coomes]

Thank you for the responses!

We will use POD formatting in our documentation. I've updated the wiki page
to reflect this.

As for the module selections, does anyone have any suggestions?


Thank you,
Andrew Coomes
Developer




On Fri, Sep 28, 2012 at 6:49 AM, Sharp, Chris
<csharp at georgialibraries.org>wrote:

> +1
>
> I agree with using POD, which can easily be converted to actual man pages
> (yay!) or asciidoc as desired.
>
> ----- Original Message -----
> > From: "Jason Stephenson" <jstephenson at mvlc.org>
> > To: open-ils-dev at list.georgialibraries.org
> > Sent: Friday, September 28, 2012 9:24:59 AM
> > Subject: Re: [OPEN-ILS-DEV] Code Documentation Proposal
> >
> > Quoting Dan Scott <dan at coffeecode.net>:
> >
> > > Hmm. I'm curious about the choice of AsciiDoc format for the inline
> > > documentation; wouldn't POD markup make much more sense (so that
> > > "perldoc OpenILS::Actor::Friends" can return something)? Or is
> > > there a
> > > perldoc variant that understands AsciiDoc?
> >
> > +1 to using POD.
> >
> >
> >
> > --
> > Jason Stephenson
> > Assistant Director for Technology Services
> > Merrimack Valley Library Consortium
> > Chief Bug Wrangler, Evergreen ILS
> >
>
> --
> Chris Sharp
> PINES Program Manager
> Georgia Public Library Service
> 1800 Century Place, Suite 150
> Atlanta, Georgia 30345
> (404) 235-7147
> csharp at georgialibraries.org
> http://pines.georgialibraries.org/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://libmail.georgialibraries.org/pipermail/open-ils-dev/attachments/20120928/140c835c/attachment.htm>