Skip to content

Commit 6acc44c

Browse files
authored
Improve non-standard messages in @deprecated (#15984)
1 parent 3790cd8 commit 6acc44c

3 files changed

Lines changed: 16 additions & 16 deletions

File tree

‎lib/elixir/lib/io/ansi.ex‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ defmodule IO.ANSI do
151151
defsequence.(:blink, 5, "m")
152152

153153
@doc "Blink: slow. Less than 150 per minute."
154-
@doc deprecated: "Use blink/0 instead."
154+
@doc deprecated: "Use blink/0 instead"
155155
defsequence.(:blink_slow, 5, "m")
156156

157157
@doc "Blink: rapid. MS-DOS ANSI.SYS; 150 per minute or more; not widely supported."
@@ -161,23 +161,23 @@ defmodule IO.ANSI do
161161
defsequence.(:inverse, 7, "m")
162162

163163
@doc "Image: negative. Swap foreground and background."
164-
@doc deprecated: "Use inverse/0 instead."
164+
@doc deprecated: "Use inverse/0 instead"
165165
defsequence.(:reverse, 7, "m")
166166

167167
@doc "Invisible. Not widely supported."
168168
@doc since: "1.21.0"
169169
defsequence.(:invisible, 8, "m")
170170

171171
@doc "Conceal. Not widely supported."
172-
@doc deprecated: "Use invisible/0 instead."
172+
@doc deprecated: "Use invisible/0 instead"
173173
defsequence.(:conceal, 8, "m")
174174

175175
@doc "Strikethrough. Not widely supported."
176176
@doc since: "1.21.0"
177177
defsequence.(:strikethrough, 9, "m")
178178

179179
@doc "Crossed-out. Characters legible, but marked for deletion. Not widely supported."
180-
@doc deprecated: "Use strikethrough/0 instead."
180+
@doc deprecated: "Use strikethrough/0 instead"
181181
defsequence.(:crossed_out, 9, "m")
182182

183183
@doc "Sets primary (default) font."
@@ -204,15 +204,15 @@ defmodule IO.ANSI do
204204
defsequence.(:italic_off, 23, "m")
205205

206206
@doc "Not italic."
207-
@doc deprecated: "Use italic_off/0 instead."
207+
@doc deprecated: "Use italic_off/0 instead"
208208
defsequence.(:not_italic, 23, "m")
209209

210210
@doc "Underline: off."
211211
@doc since: "1.21.0"
212212
defsequence.(:underline_off, 24, "m")
213213

214214
@doc "Underline: none."
215-
@doc deprecated: "Use underline_off/0 instead."
215+
@doc deprecated: "Use underline_off/0 instead"
216216
defsequence.(:no_underline, 24, "m")
217217

218218
@doc "Blink: off."
@@ -222,23 +222,23 @@ defmodule IO.ANSI do
222222
defsequence.(:inverse_off, 27, "m")
223223

224224
@doc "Image: positive. Normal foreground and background."
225-
@doc deprecated: "Use inverse_off/0 instead."
225+
@doc deprecated: "Use inverse_off/0 instead"
226226
defsequence.(:reverse_off, 27, "m")
227227

228228
@doc "Invisible: off."
229229
@doc since: "1.21.0"
230230
defsequence.(:invisible_off, 28, "m")
231231

232232
@doc "Reveal: Not concealed."
233-
@doc deprecated: "Use invisible_off/0 instead."
233+
@doc deprecated: "Use invisible_off/0 instead"
234234
defsequence.(:reveal, 28, "m")
235235

236236
@doc "Strikethrough: off."
237237
@doc since: "1.21.0"
238238
defsequence.(:strikethrough_off, 29, "m")
239239

240240
@doc "Not crossed-out."
241-
@doc deprecated: "Use strikethrough_off/0 instead."
241+
@doc deprecated: "Use strikethrough_off/0 instead"
242242
defsequence.(:not_crossed_out, 29, "m")
243243

244244
colors = [:black, :red, :green, :yellow, :blue, :magenta, :cyan, :white]
@@ -274,7 +274,7 @@ defmodule IO.ANSI do
274274
defsequence.(:overline, 53, "m")
275275

276276
@doc "Overlined."
277-
@doc deprecated: "Use overline/0 instead."
277+
@doc deprecated: "Use overline/0 instead"
278278
defsequence.(:overlined, 53, "m")
279279

280280
@doc "Not framed or encircled."
@@ -285,7 +285,7 @@ defmodule IO.ANSI do
285285
defsequence.(:overline_off, 55, "m")
286286

287287
@doc "Not overlined."
288-
@doc deprecated: "Use overline_off/0 instead."
288+
@doc deprecated: "Use overline_off/0 instead"
289289
defsequence.(:not_overlined, 55, "m")
290290

291291
@doc "Clears screen."
@@ -299,7 +299,7 @@ defmodule IO.ANSI do
299299
defsequence.(:cursor_home, "", "H")
300300

301301
@doc "Sends cursor home."
302-
@doc deprecated: "Use cursor_home/0 instead."
302+
@doc deprecated: "Use cursor_home/0 instead"
303303
defsequence.(:home, "", "H")
304304

305305
@doc """
@@ -326,7 +326,7 @@ defmodule IO.ANSI do
326326
defsequence.(:cursor_forward, "", "C")
327327

328328
@doc "Sends cursor one column to the right."
329-
@doc deprecated: "Use cursor_forward/0 instead."
329+
@doc deprecated: "Use cursor_forward/0 instead"
330330
@spec cursor_right() :: String.t()
331331
def cursor_right(), do: "\e[1C"
332332

@@ -339,7 +339,7 @@ defmodule IO.ANSI do
339339
defsequence.(:cursor_backward, "\b", nil)
340340

341341
@doc "Sends cursor one column to the left."
342-
@doc deprecated: "Use cursor_backward/0 instead."
342+
@doc deprecated: "Use cursor_backward/0 instead"
343343
@spec cursor_left() :: String.t()
344344
def cursor_left(), do: "\e[1D"
345345

‎lib/elixir/lib/kernel/parallel_compiler.ex‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ defmodule Kernel.ParallelCompiler do
5252
Starts a task for parallel compilation.
5353
"""
5454
# TODO: Remove me on Elixir 2.0
55-
@deprecated "Use `pmap/2` instead"
55+
@deprecated "Use pmap/2 instead"
5656
def async(fun) when is_function(fun, 0) do
5757
{ref, task} = inner_async(fun)
5858
send(task.pid, ref)

‎lib/elixir/lib/uri.ex‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ defmodule URI do
4040

4141
# We don't use opaque because URIs can be inlined,
4242
# either via module attributes or by the compiler.
43-
@typedoc deprecated: "The authority field is deprecated"
43+
@typedoc deprecated: "Use the userinfo, host, and port fields instead"
4444
@type authority :: nil | binary
4545

4646
@type t :: %__MODULE__{

0 commit comments

Comments
 (0)