Fix NamedTuples Formatting #803
Conversation
|
@vroulet most of the classes / states in transform.py and combine.py don't have proper docstrings. would it still be worthwhile to remove :members: for those files (many of those classes won't have much rendered bc of no docstring) |
|
Hello @amosyou (sorry got too many mails didn't catch this notification). It's better not to have a docstring than having a confusing one. So yes, you can remove :members: to all classes and we may fill all the docstrings later (one file at a time probably). |
amosyou
force-pushed
the
namedtuples_formatting
branch
from
8a478c2
to
d44b905
Compare
amosyou
force-pushed
the
namedtuples_formatting
branch
from
5dbe9cb
to
6398a1e
Compare
|
@vroulet i removed the :members: from all the states with the exception of SAMState in sam.py since SAMState uses the chex.dataclass decorator instead of inheriting from NamedTuple. for consistency should we change that to be a namedtuple? |
|
That's great, it will really make the doc more readable! |
docs/api/optimizer_wrappers.rst
Outdated
There was a problem hiding this comment.
Since you made a pass on all States here to have a nice formatting you can keep the members attribute.
My idea was:
- if you're brave and you change the docstring such that it's properly formatted, then let's keep
:members:for that state. - otherwise, simply remove
:members:and we may take care of the formatting of the states later.
There was a problem hiding this comment.
sounds good! i brought back the members
|
Could you also merge with main to see latest changes? (for example I'm not sure why States such as ClipState are displayed as alias of tuple instead of alias of EmptyState) |
|
@vroulet apologies on the delay! been quite a month for me but we're back. ready for another review :) |
There was a problem hiding this comment.
Thank you very much @amosyou. It's close to be good!
I have (hopefully last) comments:
- Remove
:members:from SAMState - Remove
:members:of all classes inoptimizer_wrappers.rst(I checked it works, that is we still have the handwritten attributes even after removing members)
|
apologies for the delay! It looks like a lot of restructuring happened since my last changes. I can open a new pull request that does these changes on the new transform subpackage? |
|
thanks @amosyou ! Yes, that's fine, do it however way its most convenient for you 😄 |
fixes duplicate formatting for classes inheriting from NamedTuples as seen in #669