XGA icon indicating copy to clipboard operation
XGA copied to clipboard

Property setters are not included in sphinx autodoc

Open DavidT3 opened this issue 2 years ago • 2 comments

The docstrings of property setters are ignored by sphinx autodoc, only possible 'solution' I've found is:

https://stackoverflow.com/questions/71713284/types-of-setter-arguments-not-showing-in-sphinx-documentation

Don't know how I missed this over the last 2 years!

DavidT3 avatar Apr 11 '23 20:04 DavidT3

This is also a much more serious problem, because in jupyter notebooks, only the getter docstring is fetched when you shift+tab to get docs up - really need to address this.

DavidT3 avatar Mar 05 '25 15:03 DavidT3

I think the only way to do sort this is to rewrite all the property getter docstrings to include the setter info as well (gulp, there are so many)

DavidT3 avatar Mar 05 '25 15:03 DavidT3