Skip to content

Commit ffc0446

Browse files
committed
Updated YamlAble docstring
1 parent 4935a5c commit ffc0446

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

yamlable/main.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,9 @@ class YamlAble(AbstractYamlAble):
5555
metaclass magic).
5656
5757
The behaviour is very similar though:
58+
- inherit from `YamlAble` or virtually inherit from it using YamlAble.register(cls)
5859
- fill the `__yaml_tag_suffix__` either directly or using the `@yaml_info()` decorator
59-
- optionally implement `__from_yaml_dict__` (class method called during decoding) and/or `__to_yaml_dict__`
60+
- optionally override `__from_yaml_dict__` (class method called during decoding) and/or `__to_yaml_dict__`
6061
(instance method called during encoding) if you wish to have control on the process, for example to only dump part
6162
of the attributes or perform some custom instance creation. Note that default implementation relies on `vars(self)`
6263
for dumping and on `cls(**dct)` for loading.

0 commit comments

Comments
 (0)