You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I was looking at the docs for Enum._serialize and got confused by what it was saying:
Serializes value to a basic Python datatype. Noop by default
And then realized this is the docstring from fields.Field and is meant for the developer who is subclassing fields.Field !
Got a bit confused there, not sure if this is the expected documentation :)
The text was updated successfully, but these errors were encountered:
AbdealiLoKo
changed the title
Documentation for _serialize/_deserialize shows parent class docs
Documentation for _serialize/_deserialize shows parent class docstring
Sep 16, 2024
The right thing to do would be not to document those methods at all IMHO. There is no added value, since they all have the same signature. The only thing we really want to see here is the class docstring of each field, which describes what it does and what its parameters are. The rest is internals.
There seems to be a lot of automatic stuff going on, I don't know when it started to happen. For instance, the Number field doc shows float methods, which is irrelevant.
I was looking at the docs for Enum._serialize and got confused by what it was saying:
And then realized this is the docstring from
fields.Field
and is meant for the developer who is subclassingfields.Field
!Got a bit confused there, not sure if this is the expected documentation :)
The text was updated successfully, but these errors were encountered: