Don't forget to bump the major version of the module (i.e. from 1.x to 2.x). Leave both the old and new versions on CPAN. Don't forget that some people will use other people's scripts that want the old module: the script still works so they don't have any reason to upgrade.

The deprecation warning is nice, but I'd at least have a way to turn it off.

Give plenty of notice of what's going to change, and give users a chance to comment on it informally. Hoepfully you know about some of the people who depend on your module and don't want to pull the rug out from under them.

Good luck :)

--
brian d foy <bdfoy@cpan.org>

In reply to Re: Changing API's of CPAN modules by brian_d_foy
in thread Changing API's of CPAN modules by cog

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


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.