Skip to content

Commit 6af19d7

Browse files
Adding docstring examples
Co-authored-by: Brian Thorne <[email protected]>
1 parent 1f5d521 commit 6af19d7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

can/util.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,12 @@ def channel2int(channel: Optional[Union[typechecking.Channel]]) -> Optional[int]
283283
def deprecated_args_alias(**aliases):
284284
"""Allows to rename/deprecate a function kwarg(s) and
285285
have the deprecated kwarg(s) set as alias(es)
286+
287+
Example:
288+
289+
@deprecated_args_alias(oldArg="new_arg", anotherOldArg="another_new_arg")
290+
def library_function(new_arg, another_new_arg):
291+
pass
286292
"""
287293

288294
def deco(f):

0 commit comments

Comments
 (0)