adds versionadded

Author: edublancas

doc/_toc.yml

@@ -13,7 +13,8 @@ parts:
 
 - caption: API Reference
   chapters:
-    - file: api
+    - file: api/deprecated
+    - file: api/telemetry
 
 - caption: Community
   chapters:

doc/api.rst

@@ -0,0 +1,5 @@
+``ploomber_core.deprecated``
+============================
+
+.. automodule:: ploomber_core.deprecated
+    :members:

doc/api/deprecated.rst

@@ -0,0 +1,6 @@
+``ploomber_core.telemetry``
+===========================
+
+.. autoclass:: ploomber_core.telemetry.Telemetry
+    :members: log_call
+

doc/api/telemetry.rst

@@ -140,7 +140,7 @@ class SomeClass:
                        custom_message="Parameters changed from x, y to a, b")
     def do_something(self, *args, **kwargs):
         return self.do_something_else(*args, **kwargs)
-    
+
     def do_something_else(self, a, b):
         return a + b
 

doc/deprecation.md

@@ -20,6 +20,10 @@ The `ploomber_core.exceptions` module implements some exceptions that customize
 
 ## `PloomberValueError`
 
+```{versionadded} 0.1
+Ensure you pin this version in the `setup.py` file (`ploomber-core>=0.1.*`)
+```
+
 A subclass of the built-in `ValueError`, use it when the value is unexpected:
 
 ```{code-cell} ipython3
@@ -48,6 +52,10 @@ call_person("John")
 
 ## `PloomberTypeError`
 
+```{versionadded} 0.1
+Ensure you pin this version in the `setup.py` file (`ploomber-core>=0.1.*`)
+```
+
 A subclass of the built-in `TypeError`, use it when the type is unexpected:
 
 ```{code-cell} ipython3
@@ -76,6 +84,10 @@ add_one("hello")
 
 ## `PloomberKeyError`
 
+```{versionadded} 0.1
+Ensure you pin this version in the `setup.py` file (`ploomber-core>=0.1.*`)
+```
+
 A subclass of the built-in `KeyError`, use it when a key is missing:
 
 ```{code-cell} ipython3

doc/exceptions.md

@@ -102,7 +102,13 @@ def wrapper(*args, **kwargs):
 
 
 def method(deprecated_in, removed_in, *, name_new=None, custom_message=None):
-    """A decorator for deprecated methods"""
+    """A decorator for deprecated methods
+
+    Notes
+    -----
+    .. versionchanged:: 0.1
+        Added ``name_new`` and ``custom_message``
+    """
 
     def decorator(fn):
         @wraps(fn)