0.4.0 changelog

Author: smarie

docs/changelog.md

@@ -1,5 +1,20 @@
 # Changelog
 
+### 0.4.0 - `YamlCodec` completed
+
+`YamlCodec` completed (fixes [#4](https://github.com/smarie/python-yamlable/issues/4)):
+ - `YamlCodec.decode_yamlable` renamed `decode` and `YamlCodec.encode_yamlable` renamed `encode`
+ - added some checks in `YamlCodec.encode` to help users implement `to_yaml_dict` correctly
+ - fixed bug in `register_with_pyyaml`: the wrong decoding method was registered
+ - `YamlCodec.create_from_yaml_dict` renamed `from_yaml_dict` for consistency
+ - added tests and usage documentation
+ 
+Renamed internal `AbstractYamlObject` methods with dunder (fixes [#3](https://github.com/smarie/python-yamlable/issues/3)): 
+ - `from_yaml_dict` becomes `__from_yaml_dict__` 
+ - and `to_yaml_dict` become `__to_yaml_dict__`
+Legacy names will remain supported for a while, added a tet to check that.
+
+
 ### 0.3.1 - minor error message improvement
 
  * Filled `yaml_info` docstring.