Doc for objects that inherit from BaseCoordinateFrame is messy

[dstansby]

e.g. see this page: http://docs.sunpy.org/en/stable/api/sunpy.coordinates.frames.HeliographicStonyhurst.html#sunpy.coordinates.frames.HeliographicStonyhurst and scroll down to "Attributes summary"

Because BaseCoordinateFrame has a few class attributes, these get automatically documented (without any docstrings) when documenting an inheriting class. It would be nice to make these disappear somehow - maybe converting them to properties, and making the class attributes hidden by putting an underscore before their names?

[pllim]

Shouldn't this be a sunpy issue? They can hide whatever they want using "exclude members" directive, no?

[dstansby]

Maybe the attributes should be documented in astropy too?

[pllim]

Sure, documenting the attributes is a good idea. However, changing the code for the sake of documentation is probably not (unless there is a very good reason to do so). Thank you for bringing this to our attention!

[pllim]

And last but not the least, you are welcome to contribute!

[dstansby]

👍 to documenting the properties - if I have time I will have a look, but busy with lots of other stuff right now

[b1quint]

May I contribute by addressing this issue?

[pllim]

@b1quint , of course. PR is welcome!