On Sat, Nov 21, 2009 at 3:14 PM, Parrot <[email protected]> wrote:
> #292: [CAGE] Update all Pod documentation to use sane, modern headings
> ---------------------+------------------------------------------------------
> Reporter: allison | Owner: jkeenan
> Type: cage | Status: assigned
> Priority: normal | Milestone:
> Component: docs | Version: trunk
> Severity: medium | Keywords:
> Lang: | Patch:
> Platform: all |
> ---------------------+------------------------------------------------------
>
> Comment(by jkeenan):
>
> In the course of working on TT #1301, I encountered some files where the
> Pod `DESCRIPTION` section consisted of nothing more than a reference to
> the RT item which this ticket replaced.
That way lies madness. If you find those and cannot come up with a
sufficient DESCRIPTION, please remove the placeholder and skip it in
the codingstd test; (We went through this same dance on function
documentation)
> That, in turn, led me to turn my
> attention to the long-neglected ''t/codingstd/pod_description.t'', which
> was showing more than 300 files which lacked a Pod `DESCRIPTION` section
> or content therein.
>
> So I have begun working my way through that list. However, in order to
> get certain files cleared off the failing list, I have had to make them
> conform to the Pod style which Allison ultimately wants replaced. My
> belief is that we are better off going ahead and checking each file
> reported as failing to see whether it has content that could be put into a
> `DESCRIPTION` section and do so -- and worry about new Pod styles later.
> So that means that in certain cases I will be replacing:
> {{{
> head1 Description
> }}}
> with
> {{{
> head1 DESCRIPTION
> }}}
> and so forth.
>
> kid51
>
> --
> Ticket URL: <https://trac.parrot.org/parrot/ticket/292#comment:12>
> Parrot <https://trac.parrot.org/parrot/>
> Parrot Development
> _______________________________________________
> parrot-tickets mailing list
> [email protected]
> http://lists.parrot.org/mailman/listinfo/parrot-tickets
>
--
Will "Coke" Coleda
_______________________________________________
parrot-tickets mailing list
[email protected]
http://lists.parrot.org/mailman/listinfo/parrot-tickets
