Skip to content

Commit ed81b1c

Browse files
committed
Fixed documentation: method names were not the dunder ones
1 parent 09aef54 commit ed81b1c

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Let's make a class yaml-able: we have to
2828

2929
- inherit from `YamlAble`
3030
- decorate it with the `@yaml_info` annotation to declare the associated yaml tag
31-
- *optionally* implement `from_yaml_dict` (class method called during decoding) and/or `to_yaml_dict` (instance method called during encoding) if we wish to have control on the process, for example to only dump part of the attributes or perform some custom instance creation. Note that default implementation relies on `vars(self)` for dumping and on `cls(**dct)` for loading.
31+
- *optionally* implement `__from_yaml_dict__` (class method called during decoding) and/or `__to_yaml_dict__` (instance method called during encoding) if we wish to have control on the process, for example to only dump part of the attributes or perform some custom instance creation. Note that default implementation relies on `vars(self)` for dumping and on `cls(**dct)` for loading.
3232

3333
```python
3434
from yamlable import yaml_info, YamlAble

0 commit comments

Comments
 (0)