Re: Pod POD pod poD pOd or P.O.D.
[email protected] (Allison Randal)
| Newsgroups | perl.pod-people |
|---|---|
| Message-ID | <[email protected]> |
Ricardo SIGNES wrote: > I am not clear on whether this paragraph says or means much: > > Throughout this document, "Pod" has been the preferred spelling for the name > of the documentation format. One may also use "POD" or "pod". For the > documentation that is (typically) in the Pod format, you may use "pod", or > "Pod", or "POD". Understanding these distinctions is useful; but obsessing > over how to spell them, usually is not. > > So: the format is POD, Pod or pod, but a document is the pod, Pod, or POD? > > Is it trying to say that all three are always acceptable and not to worry about > it? If there is an intended distinction, I'd like to clarify it. > > I'd think "Pod" for the format and "pod" for "the pod of that module over > there." > > (FWIW, I'm submitting a few patches to this doc to p5p to correct obvious > errors.) I generally restrict the usage in my work and anything I edit to "Pod" for the format or documentation in the format and ".pod files" for all-Pod documents. All-caps POD is old-school, circa 1990's. I see it around, but it always looks anachronistic. Still, I suspect old-school preferences are strong enough that any p5p patches will have to fuzzily say that all capitalizations are acceptable. I'd edit that to something like: > Throughout this document, "Pod" has been the preferred spelling for the name > of the documentation format. One may also use "POD" or "pod". > There's more than one way to do it. Allison