You're not breaking CPAN but your modules on CPAN :)

Also, there is no "Foo" module on CPAN :)

But you have two choices -- break it, and let the chips fall where they may -- or maintain API compatibility (  HTML::Parser->new( api_version => 3, ... )

So, you've decided to change things, great, do whatever you feel will cause the least pain for those (if any) users of your code

a logical way would be to keep both old and new versions independent but I don't see a way to do that with CPAN

Sure you do, make a new namespace, as in Foo2

It basically comes down to promises you made :) If you warned users that API may change in future versions, then they were warned :)

Piece of advice, if your docs/tutorials/videos... are outdated with respect to the current working API, go with the rename ... invalidating existing docs/tutorials with API changes is super weak self inflicted stupidity regardless of the promises you made ... if you can't delete the videos rename :)

See also Update module and break api, or change namespace

I think whatever your product, rename is the simplest, think fork

In reply to Re: Controlled CPAN breakage (breaking my modules API stability promises) by Anonymous Monk
in thread Controlled CPAN distribution breakage by dwalin

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.