Repository navigation
Improve non-standard messages in @deprecated - #15984
Merged
Merged
Conversation
ExDoc appends a period to the deprecation message in the `This <%= node.type %> is deprecated. <%= h(deprecated) %>.` template, resulting in double periods when messages end with punctuation. Assisted-by: Antigravity:gemini-3.8-flash
Deprecation messages throughout Elixir avoid backticks around identifiers. Assisted-by: Antigravity:gemini-3.8-flash
ExDoc renders `@typedoc deprecated:` as `This type is deprecated. <message>.`. Phrasing the message as "The authority field is deprecated" duplicates the deprecation statement in the documentation. Suggest using the individual fields instead. Assisted-by: Antigravity:gemini-3.8-flash
Contributor
Author
Member
|
💚 💙 💜 💛 ❤️ |
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
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 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.Typical deprecation messages follow the formula
"Use ... instead".Problems addressed:
@docmarkdown text, but not to be used in@deprecatedmessage plain text.I reviewed occurrences via
git grep -nP '@deprecated |@\w*doc deprecated: ', and decided to only update user-facing ones, ignoring entries with@moduledoc falseor@doc falseto avoid unnecessary churn.