Skip to content

Commit be6a91a

Browse files
committed
exc(docs[DeprecatedError]): Add NumPy-style parameter documentation
why: CLAUDE.md requires NumPy docstring style for all functions/methods what: - Add Parameters section documenting deprecated, replacement, version
1 parent 2b359dd commit be6a91a

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/libtmux/exc.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ class DeprecatedError(LibTmuxException):
2323
"""Raised when a deprecated function, method, or parameter is used.
2424
2525
This exception provides clear guidance on what to use instead.
26+
27+
Parameters
28+
----------
29+
deprecated : str
30+
The name of the deprecated API (e.g., "Pane.resize_pane()")
31+
replacement : str
32+
The recommended replacement API to use instead
33+
version : str
34+
The version when the API was deprecated (e.g., "0.28.0")
2635
"""
2736

2837
def __init__(

0 commit comments

Comments
 (0)