Deprecating functions
Bardur Arantsson
spam at scientician.net
Fri Jan 9 16:24:57 UTC 2015
On 2015-01-09 11:25, Herbert Valerio Riedel wrote:
> On 2015-01-09 at 11:18:02 +0100, Jan Stolarek wrote:
>
>> The reall
>> question is how to remember that we should remove this at some point?
>
> This affects all exposed libraries; I think it's enough to simply make
> this part of the release-procedure at some point in the release-cycle,
> to actively scan all DEPRECATIONs, and decide for each whether to kill
> them or let them live for another cycle.
>
> It simplifies things though, if it's obvious when a deprecation was
> declared so one doesn't have to `git blame` for it. Many deprecations
> already have a comment attached like "deprecated in GHC x.y"
>
I think Google's Guava library for Java does a great job at this. In the
documentation is says something like:
*Deprecated*: Use xxx instead. This class is scheduled for removal in
June 2016.
Then one just needs to add a "Remove all scheduled deprecations" to the
do-a-release checklist.
More information about the ghc-devs
mailing list