dataclasses-json
dataclasses-json copied to clipboard
Documentation error: Extension example repeats Override example
In the documentation at https://pypi.org/project/dataclasses-json/, the section named 'Extending' is supposed to explain how to extend dataclasses_json
to change the behaviour of certain field types. However, the included example code is instead a repeat of the sample code from the 'Overriding' section, showing how to change the behaviour of a specific field.
The documentation looks correct to me. Overriding uses this example: https://github.com/lidatong/dataclasses-json/blob/4a24b1261ee55e876c56665d72501f303e62f5c4/README.md?plain=1#L498-L512 And extending uses this example: https://github.com/lidatong/dataclasses-json/blob/4a24b1261ee55e876c56665d72501f303e62f5c4/README.md?plain=1#L520-L533 They are different ways of achieving the same behaviour.
@matt035343: The documentation at https://lidatong.github.io/dataclasses-json/#overriding-extending uses the same example code in both cases.
I see, then I am unsure how the docs are updated. Maybe @lidatong can hint how to do so?
the docs used to be regenerated as part of a release script, but that accidentally got dropped when migrating to gh actions
Will fix