astropy / astropy/astropy

Add docstrings for default coordinate frame attributes

Open
#9,548 5 comments 0 reactions 0 assignees View on GitHub
coordinates Docs Feature Request
Dominant language
Python
Stars
5.3k
Forks
2.2k
Avg merge
1d 20h
Merged PRs (30d)
81

Description

### Description

Presently, for example, [the docs](https://docs.astropy.org/en/stable/api/astropy.coordinates.AltAz.html#astropy.coordinates.AltAz) don't list `alt` or `az` as attributes on the `AltAz` object, making them difficult to discover for new users.

A docs fix for this would make `alt` and `az` appear in the "Attributes Summary" section of the `AltAz` page.

Contributor guide

Open the contributing guide

Research direction

Start from the astropy.coordinates.AltAz API documentation page and trace its Attributes Summary to the coordinate-frame attribute definitions. Check how existing attributes are exposed in the generated docs, then document alt and az so they appear in that summary. Verify the rendered AltAz page lists both attributes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.