Deprecation table

66 views
Skip to first unread message

eksperimental

unread,
Feb 21, 2017, 9:05:30 PM2/21/17
to elixir-l...@googlegroups.com
I would also like to propose to introduce a new page in the project that lists all the deprecated
functions, what was the version it was deprecated, and if they have been
replaced/renamed by new function.

It happed to me once that I was using a package that was written for elixir 0.9.x,
this function was renamed in 1.0, and then deprecated or renamed again (can't remember)
in a later minor version. So finding the current function was not as straight-forward as I would
have wanted it.

Ideally I would like it to include pre-1.0 elixir version.
I can volunteer myself to start with a mock-up and eventually start filling up the table.

Please let me know what you think

José Valim

unread,
Feb 22, 2017, 5:54:54 AM2/22/17
to elixir-l...@googlegroups.com
I agree such table is important, +1. Some clarifications:

1. We should include when the version was deprecated (i.e. we started emitting warnings) as well as when the replacement function has been available. Most times, the replacement function is available at least two releases before the deprecation. It is important to keep this perspective.

2. We should not include anything pre 1.0 because that would make the table unnecessarily large and it wouldn't be helpful for the huge majority of developers.

By sticking to 1.0, hopefully the table is not hard to assemble, giving it is a matter of reading the changelogs and searching for "deprecate" in the code base.

Finally, I would suggest for this table to be listed in a page called "Deprecations" (alongside the "Operators" page and others). We should likely move our deprecation policy there: https://github.com/elixir-lang/elixir/blob/master/RELEASE.md#deprecation-policy

Thank you for looking into this!



José Valim
Skype: jv.ptec
Founder and Director of R&D


--
You received this message because you are subscribed to the Google Groups "elixir-lang-core" group.
To unsubscribe from this group and stop receiving emails from it, send an email to elixir-lang-core+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/elixir-lang-core/20170222090523.767b36c1.eksperimental%40autistici.org.
For more options, visit https://groups.google.com/d/optout.

eksperimental

unread,
Feb 22, 2017, 8:24:27 AM2/22/17
to elixir-l...@googlegroups.com
You are welcome José.
I agree on all the points.
I will work on a draft and submit it as Work-in-progress Pull Request.

Cheers,

On Wed, 22 Feb 2017 11:54:32 +0100
José Valim <jose....@plataformatec.com.br> wrote:

> I agree such table is important, +1. Some clarifications:
>
> 1. We should include when the version was deprecated (i.e. we started
> emitting warnings) as well as when the replacement function has been
> available. Most times, the replacement function is available at least two
> releases before the deprecation. It is important to keep this perspective.
>
> 2. We should not include anything pre 1.0 because that would make the table
> unnecessarily large and it wouldn't be helpful for the huge majority of
> developers.
>
> By sticking to 1.0, hopefully the table is not hard to assemble, giving it
> is a matter of reading the changelogs and searching for "deprecate" in the
> code base.
>
> Finally, I would suggest for this table to be listed in a page called
> "Deprecations" (alongside the "Operators" page and others). We should
> likely move our deprecation policy there:
> https://github.com/elixir-lang/elixir/blob/master/RELEASE.md#deprecation-policy
>
> Thank you for looking into this!
>
>
>
> *José Valim*
> www.plataformatec.com.br
> Skype: jv.ptec
> Founder and Director of R&D
>
> On Wed, Feb 22, 2017 at 3:05 AM, eksperimental <eksper...@autistici.org>
> wrote:
>
> > I would also like to propose to introduce a new page in the project that
> > lists all the deprecated
> > functions, what was the version it was deprecated, and if they have been
> > replaced/renamed by new function.
> >
> > It happed to me once that I was using a package that was written for
> > elixir 0.9.x,
> > this function was renamed in 1.0, and then deprecated or renamed again
> > (can't remember)
> > in a later minor version. So finding the current function was not as
> > straight-forward as I would
> > have wanted it.
> >
> > Ideally I would like it to include pre-1.0 elixir version.
> > I can volunteer myself to start with a mock-up and eventually start
> > filling up the table.
> >
> > Please let me know what you think
> >
> > --
> > You received this message because you are subscribed to the Google Groups
> > "elixir-lang-core" group.
> > To unsubscribe from this group and stop receiving emails from it, send an
> > email to elixir-lang-co...@googlegroups.com.

eksperimental

unread,
Feb 22, 2017, 5:59:02 PM2/22/17
to elixir-l...@googlegroups.com
First draft
https://github.com/eksperimental/elixir/blob/deprecations/lib/elixir/pages/Deprecations.md

PR is here
https://github.com/elixir-lang/elixir/pull/5808

Please everyone let me know what you think or how it could be improved,
thank you.

Jon Parise

unread,
Feb 22, 2017, 6:17:49 PM2/22/17
to elixir-l...@googlegroups.com
A very minor piece of feedback, but I think "Deprecated In" reads slightly better than "Deprecated By" when the column's value is the version that introduced the deprecation.


> > > To view this discussion on the web visit https://groups.google.com/d/
> > > msgid/elixir-lang-core/20170222090523.767b36c1.
> > > eksperimental%40autistici.org.
> > > For more options, visit https://groups.google.com/d/optout.
> > >
> >
>
--
You received this message because you are subscribed to the Google Groups "elixir-lang-core" group.
To unsubscribe from this group and stop receiving emails from it, send an email to elixir-lang-core+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/elixir-lang-core/20170223055855.78b58930.eksperimental%40autistici.org.

eksperimental

unread,
Feb 22, 2017, 6:22:56 PM2/22/17
to elixir-l...@googlegroups.com
Subtle difference, but correct!
Thanks a lot.
> > > > > email to elixir-lang-co...@googlegroups.com.
> > > > > To view this discussion on the web visit
> > https://groups.google.com/d/
> > > > > msgid/elixir-lang-core/20170222090523.767b36c1.
> > > > > eksperimental%40autistici.org.
> > > > > For more options, visit https://groups.google.com/d/optout.
> > > > >
> > > >
> > >
> >
> > --
> > You received this message because you are subscribed to the Google Groups
> > "elixir-lang-core" group.
> > To unsubscribe from this group and stop receiving emails from it, send an
> > email to elixir-lang-co...@googlegroups.com.
> > To view this discussion on the web visit https://groups.google.com/d/ms
> > gid/elixir-lang-core/20170223055855.78b58930.eksperimental%40autistici.org
> > .
Reply all
Reply to author
Forward
0 new messages