Improve documentation about headers
- Dominant language
- Python
- Stars
- 204
- Forks
- 135
- Avg merge
- 12h 55m
- Merged PRs (30d)
- 1
Description
Based on discussion in #617 , there is a need for more documentation about headers.
I propose a Header section be added to [Working with Spectrum1Ds](https://specutils.readthedocs.io/en/stable/spectrum1d.html#working-with-spectrum1ds).
Something like:
# Headers
There is currently not universally standard behavior for the handling of header information. In particular, header data is not guaranteed to be preserved or updated. Users should take care with monitoring any important header keywords.
A common practice is to store the primary header in `meta['header']` rather than in `meta` directly.
[a couple examples..]
Contributor guide
Research direction
Open the Working with Spectrum1Ds page linked in the issue and locate its documentation source. Read the discussion in #617 for context, then add the proposed Headers section and a couple of relevant examples. Done means the page clearly explains header preservation and the meta['header'] convention, with the documentation building successfully.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100