Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
Ignore it as nobody reads change logs anyway

Addressing this part in isolation, I hope you're joking.

In case not, it is worth stating that clear, complete change logs are highly important. When a new version is released the first question a user might ask is "Why?". It could be a security fix or another type of bug fix or a performance enhancement or a new feature or a removal of previously deprecated functionality/syntax or just typo fixes in POD or any combination thereof. The change log informs the user of whether (given their own individual circumstances) they must, should, might, shouldn't or mustn't upgrade.

If you are writing code yourself which has prerequisites, how do you know which version of those prerequisites your code requires? I often find that my code has casually used some feature of a rapidly-developing module which is not present in older versions. Without a change log there is no simple way to tell which version introduced this feature and therefore which version my code requires.

If you have different versions of a module running on different systems and some versions are reporting errors when others are not, how can you determine the reason if there is no changelog to enumerate the differences?

Good change logs are on the long list of things in IT which nobody really notices when they are there but it suddenly becomes clear how important they are when absent.


In reply to Re: Module Change Log by hippo
in thread Module Change Log by Bod

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

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

How do I use this? | Other CB clients
Other Users?
Others cooling their heels in the Monastery: (3)
As of 2023-10-01 01:24 GMT
Find Nodes?
    Voting Booth?

    No recent polls found