Docs: Add missed options to decorator API

biqqles / dataclassy

A fast and flexible reimplementation of data classes

https://pypi.org/project/dataclassy

Mozilla Public License 2.0

82 stars 9 forks source link

Closed thisisrandy closed 3 years ago

thisisrandy commented 3 years ago

Namely, unsafe_hash and order, while having a descriptive section further down, are not mentioned in the top-level statement of the API

biqqles commented 3 years ago

Nicely spotted, thanks. This made me realise I wasn't quite happy with the order DEFAULT_OPTIONS was in, so I fixed that here: https://github.com/biqqles/dataclassy/commit/3b061abab68abcccd9935e0154aecf6f095bcd07

Could you possibly update the signature in the docs to match that order?

thisisrandy commented 3 years ago

Done, and in the decorator.dataclass docstring as well

biqqles commented 3 years ago

Thank you very much!