search

haskell / mtl

The Monad Transformer Library
http://www.haskell.org/haskellwiki/Monad_Transformers
Other
360 stars 63 forks source link

Add note to Haddock about possible removals of re-exports #106

Closed tomjaguarpaw closed 2 years ago

tomjaguarpaw commented 2 years ago

If one long term possibility is that we remove certain re-exports from mtl modules it seems like the documentation should warn about this. Of course, this is not as good as deprecating the re-exports, but that functionality doesn't exist, and in its absence it seems like this would be an important way to communicate future potential breakage to users.

screenshot

kozross commented 2 years ago

@tomjaguarpaw: Given this and this, I believe we should go further, tear off the band-aid, and just remove the re-exports completely.

tomjaguarpaw commented 2 years ago

I'm inclined to agree that we should completely remove the re-exports in the next major release, but can we make a point release first (or indeed "at the same time") containing all the non-breaking changes that it can? That would provide a smoother upgrade path.

kozross commented 2 years ago

I think we should just take the big step now. Splitting it up like this is unlikely to be much better, and I honestly can't see good reason for it. Improvement is long overdue, and this is a very bad legacy decision.

tomjaguarpaw commented 2 years ago

As you wish. I am in support of Bodigrim's comments on #101. Personally I think it it would be preferable for the band aid to be ripped off quickly with respect to the passage of time but slowly with respect to the increase of version numbers. As Bodigrim says, 2.3 can be released at the same time as 2.4. I believe that would provide a smoother experience for users. But ultimately the choice rests with you.

kozross commented 2 years ago

@emilypi I think this has been superceded already?

emilypi commented 2 years ago

Yeah - you did write the thing that's true.