Repository navigation
Remove redundant text in @deprecated messages - #6876
Merged
Merged
Conversation
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.
SteffenDE
approved these changes
Oct 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
While reviewing what's coming new in Elixir v1.21 and eventually proposing elixir-lang/ex_doc#2274, I noticed a few of the
@deprecatedmessages produced suboptimal documentation in HexDocs and compiler warnings.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.I did not touch messages in
@moduledoc falsemodules or@doc falsefunctions, as they are not visible in HexDocs anyway, thus avoiding unnecessary churn.Live docs: