Style deprecation notices in the API reference - #198
Merged
Merged
Conversation
Style the `deprecated` admonition class like a warning, but with the `material/grave-stone` icon and its own colour, so deprecation notices read as deprecation notices and not as generic warnings. That class is what a hand-written `Deprecated:` admonition in a docstring produces, and also what the griffe extension added next will emit, so a single rule covers both sources. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Wire the `griffe-warnings-deprecated` extension into the mkdocstrings handler options, so every symbol decorated with `typing_extensions.deprecated` gets a "Deprecated" admonition in the API reference with no docstring edit at all. The extension's `kind` is set to `deprecated` rather than the default `warning`, so it emits `class="deprecated"`, which is exactly what a hand-written `Deprecated:` admonition produces. The CSS rule added in the previous commit then styles both, and the two are visually indistinguishable. That matters because the decorator cannot reach everything: module-level aliases, a single function argument, enum members and whole modules still need the admonition written by hand. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
github-actions
Bot
added
part:docs
llucax
enabled auto-merge
September 21, 2026 12:46
Contributor
Author
|
Example of how it looks. 
|
llucax
disabled auto-merge
September 21, 2026 12:52
`LessThanComparableOrNoneT` announced its deprecation through a `Warning: Deprecated` admonition, which renders as an ordinary warning and so reads like any other caveat. Write it as a `Deprecated:` admonition instead, so it picks up the deprecation styling added in this branch, and state the version that deprecated it in the text, as the deprecations guide requires. The decorator cannot reach a module-level type variable, so a hand-written admonition is the only channel there is. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
llucax
added
the
cmd:skip-release-notes
Contributor
Author
|
Updated: pushed cafa552 and rewrote the description. The PR originally only added the styling and left existing notices alone. It now also converts this repo's one deprecation notice to match. Because that touches |
llucax
enabled auto-merge
September 21, 2026 17:00
daniel-zullo-frequenz
approved these changes
Sep 22, 2026
Merged
via the queue into
frequenz-floss:v1.x.x
with commit Sep 22, 2026
ca06caf
12 of 13 checks passed
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.
Preparation for the client-common 0.4.1 update, so deprecation notices already look right by the time it adds more of them.
Two things: a CSS rule that styles the
deprecatedadmonition class (gravestone icon, its own colour, otherwise like a warning), and the griffe-warnings-deprecated extension wired into the mkdocstrings handler so symbols decorated withtyping_extensions.deprecatedget an admonition generated for them.The extension's
kindis set todeprecatedrather than the defaultwarning, so what it emits is markup-identical to a hand-writtenDeprecated:admonition. One rule styles both, which matters because the decorator cannot reach module-level aliases, a single function argument, enum members or whole modules.Then a third commit brings this repo's one deprecation notice in line with the deprecations guide:
LessThanComparableOrNoneTannounced itself withWarning: Deprecated, which renders as an ordinary warning, and it is now aDeprecated:admonition that states the version (v1.4.0) in the text. The decorator cannot reach a module-level type variable, so that admonition is the only channel it has.