Skip to content

Commit 1bae3a6

Browse files
authored
Remove redundant text in @deprecated messages (#6876)
ExDoc renders "This function is deprecated. {...}.", so messages should not repeat "deprecated" nor end in punctuation. Using MFA instead of function call syntax to refer to an alternative function, e.g. `get_flash/2`, is idiomatic and consistent. Do not touch messages in `@moduledoc false` modules or `@doc false` functions, as they are not visible in HexDocs anyway, thus avoiding unnecessary churn.
1 parent e9eeba2 commit 1bae3a6

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

‎lib/phoenix/controller.ex‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1714,7 +1714,7 @@ defmodule Phoenix.Controller do
17141714
%{"info" => "Welcome Back!"}
17151715
17161716
"""
1717-
@deprecated "get_flash/1 is deprecated. Use the @flash assign provided by the :fetch_flash plug"
1717+
@deprecated "Use the @flash assign provided by the :fetch_flash plug"
17181718
def get_flash(conn) do
17191719
Map.get(conn.assigns, :flash) ||
17201720
raise ArgumentError, message: "flash not fetched, call fetch_flash/2"
@@ -1730,7 +1730,7 @@ defmodule Phoenix.Controller do
17301730
"Welcome Back!"
17311731
17321732
"""
1733-
@deprecated "get_flash/2 is deprecated. Use Phoenix.Flash.get(@flash, key) instead"
1733+
@deprecated "Use Phoenix.Flash.get/2 instead"
17341734
def get_flash(conn, key) do
17351735
get_flash(conn)[flash_key(key)]
17361736
end

‎lib/phoenix/test/conn_test.ex‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,14 +274,14 @@ defmodule Phoenix.ConnTest do
274274
Gets the whole flash storage.
275275
"""
276276
@spec get_flash(Conn.t) :: map
277-
@deprecated "get_flash/1 is deprecated. Use conn.assigns.flash instead"
277+
@deprecated "Use conn.assigns.flash instead"
278278
def get_flash(conn), do: conn.assigns.flash
279279

280280
@doc """
281281
Gets the given key from the flash storage.
282282
"""
283283
@spec get_flash(Conn.t, term) :: term
284-
@deprecated "get_flash/2 is deprecated. Use Phoenix.Flash.get/2 instead"
284+
@deprecated "Use Phoenix.Flash.get/2 instead"
285285
def get_flash(conn, key) do
286286
Phoenix.Flash.get(conn.assigns.flash, key)
287287
end

0 commit comments

Comments
 (0)