Skip to content

Commit 1684c80

Browse files
author
José Valim
committed
Add advice regards deprecations
1 parent 00bed7d commit 1684c80

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

lib/elixir/lib/module.ex

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,13 @@ defmodule Module do
118118
The mix compiler automatically looks for calls to deprecated modules
119119
and emit warnings during compilation, computed via `mix xref warnings`.
120120
121+
We recommend using this feature with care, especially library authors.
122+
Deprecating code always pushes the burden towards library users. We
123+
also recommend for deprecated functionality to be maintained for long
124+
periods of time, even after deprecation, giving developers plenty of
125+
time to update (except for cases where keeping the deprecated API is
126+
undesired, such as in the presence of security issues).
127+
121128
### `@doc` (and `@since`)
122129
123130
Provides documentation for the function or macro that follows the

0 commit comments

Comments
 (0)