comment on

Yet another manafestation of TIMTOWTDI. The fault isn't with POD, which is just a form of mark up, but with inconsistency with its use. You can't avoid people using the richness that is provided in ways you didn't anticipate; that's what people do.

Changing from one type of markup to another doesn't solve the fundamental problem, and in the case of POD to XML, probably makes it worse!

Remember the context for POD. It is to help provide documentation in the source, so any markup that is used to manage formatting in some other context has to be pretty light weight or the documentation just doesn't fit with being in the source in the first place.

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.

Perl is Huffman encoded by design.

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

Are you posting in the right place? Check out Where do I post X? to know for sure.
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
Want more info? How to link or How to display code and escape characters are good places to start.


Do you know where your variables are?
	PerlMonks