Beefy Boxes and Bandwidth Generously Provided by pair Networks
P is for Practical
 
PerlMonks  

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

Thank you for your input, I think you have a couple valid points nestled in there.

What you do with pod, and how you choose to manipulate pod, should never affect pod itself, as perl views it.

Good point. I agree that whatever changes occur, they should only suppliment the present system, not alter it. Also, any new additions should not break systems that correctly use present standards.

As for pod maintenance, well, you will run into the same issue even if you have some magical software do programmatic changes to the pod, you still gotta write it ... basic documentation trap

Well.. I agree. You do still have to write it. But writing pod and maintenance of pod are not the same thing. It is easy to remember to write pod as you are creating something new. Remembering all the places you need to update your pod when you make a change 9 months later is harder. While self-updating pod doesn't remove the responsibility of checking the pod from the programmer, it does make it more difficult for something to be missed.

Perhaps you ought to do just that, write a module that when fed a source file would do just what you want it to do

Good point. I suppose the best way to go about making changes is to provide a proof of concept and let people kick the tires around before proposing it as a standard.


In reply to Re: (podmaster speaks) Re: Thoughts on pod. by ehdonhon
in thread Thoughts on pod. by ehdonhon

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • 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 or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others imbibing at the Monastery: (7)
As of 2021-10-27 14:05 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    My first memorable Perl project was:







    Results (93 votes). Check out past polls.

    Notices?