/ docs / examples / notitle.py
notitle.py
 1  # notitle.py
 2  import warnings
 3  
 4  
 5  @warnings.deprecated(
 6      "This function is deprecated, use [`other_function`][normal.other_function] instead.",
 7      category=DeprecationWarning,
 8  )
 9  def function() -> int:
10      """Do something.
11  
12      Do something in a suboptimal manner.
13  
14      Returns:
15          An integer.
16      """
17      return 0