Skip to content

Commit cafa552

Browse files
committed
docs: Convert the deprecation notice to a Deprecated: admonition
`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>
1 parent 62c3338 commit cafa552

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

‎src/frequenz/core/math.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ def __lt__(self, other: Self, /) -> bool:
4545
)
4646
"""Type variable for a value that is [`LessThanComparable`][..LessThanComparable] or `None`.
4747
48-
Warning: Deprecated
49-
This type variable is deprecated and it will be removed in a future version. Use
50-
[`LessThanComparableT`][..LessThanComparableT] instead.
48+
Deprecated:
49+
This type variable is deprecated since v1.4.0 and it will be removed in a
50+
future version. Use [`LessThanComparableT`][..LessThanComparableT] instead.
5151
"""
5252

5353

0 commit comments

Comments
 (0)