astropy / astropy/astropy

Update modeling BlackBody docs to expand use of scale keyword

Open
#9,995 0 comments 0 reactions 0 assignees View on GitHub
Docs modeling
Dominant language
Python
Stars
5.3k
Forks
2.2k
Avg merge
1d 18h
Merged PRs (30d)
74

Description

### Description

The new as of v4.0 BlackBody model has the scale keyword that can be used to change the units of the returned values. This is explained in the docs for the deprecated blackbody functions. It would be good to add examples of how to get flam units (for example) instead of the default fnu units.

### Additional context

Contributor guide

Open the contributing guide

Research direction

Start with the BlackBody model documentation and compare it with the documentation for the deprecated blackbody functions, where scale and flam units are already discussed. Add examples showing how to use scale to obtain flam units instead of the default fnu units, then build the documentation and check that the examples render correctly.

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
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.