dataclasses-json icon indicating copy to clipboard operation
dataclasses-json copied to clipboard

Documentation error: Extension example repeats Override example

Open macdjord opened this issue 2 years ago • 4 comments

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.

macdjord avatar Feb 18 '22 20:02 macdjord

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 avatar Jul 22 '23 08:07 matt035343

@matt035343: The documentation at https://lidatong.github.io/dataclasses-json/#overriding-extending uses the same example code in both cases.

macdjord avatar Sep 25 '23 23:09 macdjord

I see, then I am unsure how the docs are updated. Maybe @lidatong can hint how to do so?

matt035343 avatar Sep 26 '23 11:09 matt035343

the docs used to be regenerated as part of a release script, but that accidentally got dropped when migrating to gh actions

Will fix

lidatong avatar Sep 26 '23 13:09 lidatong