From 7c2d3d138dc1fae0a671a2424afc5310b14225ea Mon Sep 17 00:00:00 2001 From: Rodolfo Carvalho Date: Mon, 12 Oct 2026 20:17:40 +0200 Subject: [PATCH] Remove redundant text in @deprecated messages 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. --- lib/phoenix/controller.ex | 4 ++-- lib/phoenix/test/conn_test.ex | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/phoenix/controller.ex b/lib/phoenix/controller.ex index 1fdb96339f..5fa0b3de03 100644 --- a/lib/phoenix/controller.ex +++ b/lib/phoenix/controller.ex @@ -1714,7 +1714,7 @@ defmodule Phoenix.Controller do %{"info" => "Welcome Back!"} """ - @deprecated "get_flash/1 is deprecated. Use the @flash assign provided by the :fetch_flash plug" + @deprecated "Use the @flash assign provided by the :fetch_flash plug" def get_flash(conn) do Map.get(conn.assigns, :flash) || raise ArgumentError, message: "flash not fetched, call fetch_flash/2" @@ -1730,7 +1730,7 @@ defmodule Phoenix.Controller do "Welcome Back!" """ - @deprecated "get_flash/2 is deprecated. Use Phoenix.Flash.get(@flash, key) instead" + @deprecated "Use Phoenix.Flash.get/2 instead" def get_flash(conn, key) do get_flash(conn)[flash_key(key)] end diff --git a/lib/phoenix/test/conn_test.ex b/lib/phoenix/test/conn_test.ex index 9def147398..8f7038cee4 100644 --- a/lib/phoenix/test/conn_test.ex +++ b/lib/phoenix/test/conn_test.ex @@ -274,14 +274,14 @@ defmodule Phoenix.ConnTest do Gets the whole flash storage. """ @spec get_flash(Conn.t) :: map - @deprecated "get_flash/1 is deprecated. Use conn.assigns.flash instead" + @deprecated "Use conn.assigns.flash instead" def get_flash(conn), do: conn.assigns.flash @doc """ Gets the given key from the flash storage. """ @spec get_flash(Conn.t, term) :: term - @deprecated "get_flash/2 is deprecated. Use Phoenix.Flash.get/2 instead" + @deprecated "Use Phoenix.Flash.get/2 instead" def get_flash(conn, key) do Phoenix.Flash.get(conn.assigns.flash, key) end