0.5.0 changelog and updated doc

smarie · Feb 12, 2020 · 0835d72 · 0835d72
1 parent 5d215fb
commit 0835d72
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,5 +1,9 @@
 # Changelog
 
-### 0.1.0 - TODO
+### 0.5.0 - First public version
 
-TODO
+ * Validate both type and value with `isinstance`, thanks to easy-to-write "validating types"
+ * `has_valid_type` and `has_valid_value` methods provided for easy auditing, as well as `is_vtype`
+ * Validation syntax fully compliant with `valid8`. Compliant error message available through a `validate()` method
+ * v-types are composable so that creating a library of reusable elements is straightforward (note: should we provide one in this library based on `valid8` [library](https://smarie.github.io/python-valid8/validation_funcs/b_base_validation_lib/) ?)  
+ * Two styles: `vtype(...)` constructor method, as well as an alternate `class ...(VType)` style to perform composition using inheritance, and write docstrings more easily.
diff --git a/docs/index.md b/docs/index.md
@@ -146,7 +146,7 @@ assert not isinstance(1, NonEmptyStr)
  * `has_valid_type` and `has_valid_value` methods provided for easy auditing, as well as `is_vtype`
  * Validation syntax fully compliant with `valid8`. Compliant error message available through a `validate()` method
  * v-types are composable so that creating a library of reusable elements is straightforward (note: should we provide one in this library based on `valid8` [library](https://smarie.github.io/python-valid8/validation_funcs/b_base_validation_lib/) ?)  
- * Alternate class-style available to perform composition using inheritance, and write docstrings more easily.
+ * Two styles: `vtype(...)` constructor method, as well as an alternate `class ...(VType)` style to perform composition using inheritance, and write docstrings more easily.
 
 ## See Also