-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doc for objects that inherit from BaseCoordinateFrame is messy #7458
Comments
Shouldn't this be a |
Maybe the attributes should be documented in astropy too? |
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! |
And last but not the least, you are welcome to contribute! |
👍 to documenting the properties - if I have time I will have a look, but busy with lots of other stuff right now |
May I contribute by addressing this issue? |
@b1quint , of course. PR is welcome! |
Anyone doing this? |
Yeah, I was trying to help on that but I could not understand what the code was doing. I should have reported on that. If you believe you can do it, go for it! |
Sure, will try |
To be more precise, some of the required info is here: astropy/astropy/coordinates/baseframe.py Lines 369 to 388 in 8006044
I suppose that writing a proper docstring for |
Is this issue still relevant or is it resolved? Should I work on it? |
Docstrings for the class properties (e.g., The class variables ( As an aside, even if the above is fixed, any frame attribute (e.g., |
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?The text was updated successfully, but these errors were encountered: