DOC: There is insufficient documentation on writers
- Dominant language
- Python
- Stars
- 204
- Forks
- 134
- Avg merge
- 12h 55m
- Merged PRs (30d)
- 1
Description
At the time of posting this, `.write` is not mentioned at all in https://specutils.readthedocs.io/en/latest/spectrum1d.html except as a column in [the table](https://specutils.readthedocs.io/en/latest/spectrum1d.html#list-of-loaders), which mostly says "no" for most of the supported formats.
The API documentation at https://specutils.readthedocs.io/en/latest/api/specutils.Spectrum1D.html#specutils.Spectrum1D.write is also very confusing because it keeps referring to `CCDData`.
Contributor guide
Research direction
Start with the spectrum1d.html page and the Spectrum1D.write API documentation linked in the issue, comparing the writer information with the existing loader table. Clarify how .write is used and correct the confusing CCDData references; the work is done when the documentation accurately describes writers and supported formats.
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
- 42/100