in reply to Re: Crash Course in POD
in thread Crash Course in POD

Nobody reads pod in pod format.

Very not true.

Most recent example is merlyn's article draft he refered to in the chatterbox. It was written in POD, but I doubt anyone has converted it to another format prior to reading it. And why would you convert it? If you understand POD, which is very easy, POD is perfectly readable (unlike some other documentation formats, xml based ones imho being the worst).

so you'll wanna use inline pod

No, I absolutely do NOT want that. And whenever I encounter code that does interleave pod with code, I podselect it and put it at the end instead. See also [style, *again

# I try not to put an __END__ token here cause mod_perl

You probably mean Apache::Registry, which is not the same as mod_perl. With mod_perl, you usually use a module with a handler in it, just like Apache::Registry itself. Please note that Apache::Registry has an __END__ token in it and works just fine.

Juerd
- http://juerd.nl/
- spamcollector_perlmonks@juerd.nl (do not use).

Replies are listed 'Best First'.
Re: Re: Re: Crash Course in POD
by PodMaster (Abbot) on Apr 23, 2003 at 08:50 UTC
    Monk please.

    merlyn is always asking for somebody to proofread his articles -- any time I help him out I most definetly use (podchecker and) pod2html before reading them.

    Yeah, inline pod is a personal style thing. I used to be like you, not liking inline pod, but now I feel its the way to go (tastes change).

    And as for mod_perl, yup, I guess I should've added cause like %80 of my dealing with mod_perl are with Apache::Registry (and alikes), so I don't assume like i'm writing some handler (I assume Registry).

    update: added like i'm writing -- besides, Registry is the handler I'm aiming for, not just some handler.


    MJD says you can't just make shit up and expect the computer to know what you mean, retardo!
    I run a Win32 PPM repository for perl 5.6x+5.8x. I take requests.
    ** The Third rule of perl club is a statement of fact: pod is sexy.

      any time I help him out I most definetly use (podchecker and) pod2html before reading them.

      This amazes me :)

      I used to be like you, not liking inline pod, but now I feel its the way to go (tastes change)

      Funny... my taste changed in the opposite direction.

      I don't assume some handler (I assume Registry).

      Apache::Registry *is* a handler ;)

      Juerd
      - http://juerd.nl/
      - spamcollector_perlmonks@juerd.nl (do not use).
      

        I used to be like you, not liking inline pod, but now I feel its the way to go (tastes change)

        Funny... my taste changed in the opposite direction.

        My taste changed a couple of times in both directions :)

        Related observation: programmers who don't use editors which do POD highlighting hate inline POD as it mixes with source code. If you have decent editor like emacs it is less a problem as it clearly visually separates code from documentation.

        --
        Ilya Martynov, ilya@iponweb.net
        CTO IPonWEB (UK) Ltd
        Quality Perl Programming and Unix Support UK managed @ offshore prices - http://www.iponweb.net
        Personal website - http://martynov.org