Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

Re^2: Please for the love of god, can I get a documentation format that doesn't suck?

by QM (Vicar)
on Sep 11, 2005 at 01:40 UTC ( #490961=note: print w/ replies, xml ) Need Help??


in reply to Re: Please for the love of god, can I get a documentation format that doesn't suck?
in thread Please for the love of god, can I get a documentation format that doesn't suck?

Probably the only solution is to provide a good set of guidelines for the use of POD (or whatever markup may be used) so that both usage and apperance are consistent.
Yes...and no.

The OP was specifically working with perlvar.pod, and complained about the inconsistency of POD usage therein. If a single document is legitimately judged inconsistent, guidelines won't help.

However, it may be that the nature of perlvar.pod is such that POD is overly taxed (or POD writers are overly taxed commenting it).

I'm curious to see whether perlvar.pod is judged to be well formatted (POD-wise) or not, and whether the blame or kudos can be lain at the feet of an individual or an anonymous horde.

-QM
--
Quantum Mechanics: The dreams stuff is made of


Comment on Re^2: Please for the love of god, can I get a documentation format that doesn't suck?

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://490961]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others contemplating the Monastery: (6)
As of 2014-07-12 02:48 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    When choosing user names for websites, I prefer to use:








    Results (238 votes), past polls