astropy / astropy/asdf-astropy
Document astropy compatibility
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 19
- Forks
- 22
- Avg merge
- 6h 1m
- Merged PRs (30d)
- 1
Description
As discussed with @sydduckworth our docs could be improved by:
- listing what portions of astropy we support (perhaps as a table of supported objects/submodules, etc)
- expanding usage examples
- linking to docs from relevant astropy documentation (for example adding a link in the modeling documentation that asdf and asdf-astropy can be used to save/load models)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing project documentation and the relevant Astropy modeling documentation. Document the supported Astropy objects or submodules, expand usage examples, and add links from relevant Astropy documentation; done means these compatibility details, examples, and cross-links are present.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100