search

briancurtin / deprecation

A library to handle automated deprecations
Apache License 2.0
88 stars 31 forks source link

Question: looking for future_warning #52

Closed zillionare closed 3 years ago

zillionare commented 3 years ago

How can I apply a future_warning? I need to warn user that some API are not stable, and prone to change later

briancurtin commented 3 years ago

That's something I think you should solve in your documentation, or possibly by using warnings.warn in your code. What you're trying to do is outside the scoe of this project, though.

>>> import warnings
>>> warnings.warn("This API is not stable and may change in the future")
<stdin>:1: UserWarning: This API is not stable and may change in the future