Document and test "unpacking" of compound models in fitters
Open
docs
effort-low
fitting
- Dominant language
- Python
- Stars
- 204
- Forks
- 134
- Avg merge
- 12h 55m
- Merged PRs (30d)
- 1
Description
See https://github.com/astropy/specutils/pull/210#discussion_r215767298 . I'm not sure how best to document this - perhaps as a worked example in the just-merged #210 fitting narrative docs?
Contributor guide
Research direction
Start with the discussion in astropy/specutils#210 and the fitting narrative documentation it references. Determine how compound-model unpacking is expected to work, then document it as a worked example and add tests for that behavior. Done means the narrative explains the workflow and the tests verify unpacking.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100