0.8.0 changelog + updated api doc

Author: Sylvain MARIE

docs/api_reference.md

@@ -35,6 +35,8 @@ Type hints for fields can be provided using the standard python typing mechanism
 
 By default `check_type` is `False`. This means that the abovementioned `type_hint` is just a hint. If you set `check_type=True` the type declared in the type hint will be validated, and a `TypeError` will be raised if provided values are invalid. Important: if you are running python < 3.6 you have to set the type hint explicitly using `type_hint` if you wish to set `check_type=True`, otherwise you will get an exception. Indeed type comments can not be collected by the code.
 
+Now type hints relying on the `typing` module (PEP484) are correctly checked using whatever 3d party type checking library is available (`typeguard` is first looked for, then `pytypes` as a fallback). If none of these providers are available, a fallback implementation is provided, basically flattening `Union`s and replacing `TypeVar`s before doing `is_instance`. It is not guaranteed to support all `typing` subtelties.
+
 **Documentation**
 
 A docstring can be provided in `doc`for code readability.

docs/changelog.md

@@ -4,7 +4,7 @@
 
 **PEP484 type hints support**
 
- - Now type hints relying on PEP484 are correctly checked using whatever is available (`typeguard`, `pytypes`). If nothing is available a fallback implementation is provided, basically flattening `Union`s and replacing `TypeVar`s before doing `is_instance`. Fixes [#7](https://github.com/smarie/python-pyfields/issues/7)
+ - Now type hints relying on the `typing` module (PEP484) are correctly checked using whatever 3d party type checking library is available (`typeguard` is first looked for, then `pytypes` as a fallback). If none of these providers are available, a fallback implementation is provided, basically flattening `Union`s and replacing `TypeVar`s before doing `is_instance`. It is not guaranteed to support all `typing` subtelties. Fixes [#7](https://github.com/smarie/python-pyfields/issues/7)
 
 
 ### 0.7.0 - more ways to define validators

pyfields/core.py

@@ -424,6 +424,11 @@ def field(type_hint=None,        # type: Type[T]
     using `type_hint` if you wish to set `check_type=True`, otherwise you will get an exception. Indeed type comments
     can not be collected by the code.
 
+    Type hints relying on the `typing` module (PEP484) are correctly checked using whatever 3d party type checking
+    library is available (`typeguard` is first looked for, then `pytypes` as a fallback). If none of these providers
+    are available, a fallback implementation is provided, basically flattening `Union`s and replacing `TypeVar`s before
+    doing `is_instance`. It is not guaranteed to support all `typing` subtelties.
+
     Documentation
     -------------
     A docstring can be provided for code readability.