New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding Explanations to Spectrum Configuration #1827
Adding Explanations to Spectrum Configuration #1827
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1827 +/- ##
==========================================
- Coverage 58.04% 57.65% -0.39%
==========================================
Files 66 66
Lines 6747 6809 +62
==========================================
+ Hits 3916 3926 +10
- Misses 2831 2883 +52
Continue to review full report at Codecov.
|
fea511e
to
9e74ac0
Compare
Before a pull request is accepted, it must meet the following criteria:
|
d02b3ea
to
db8ed8a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lines 11-13 could use some better explanation and clean-up (I know you did not write them). Start
should not be capitalized and I'd probably say "value with units" as opposed to "quantity with units" as they are not expressed as astropy quantities. Also, I don't entirely like how it uses "frequency space" as I think we can explain that with less technical vocabulary.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than these quick fixes (you can just commit them directly from github) it looks good to go!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great!
Description
Added Explanations to the Spectrum Configuration Section of the Documentation
Motivation and context
The original did not have a description of how to edit method parameters, so this would be nice for newer users
How has this been tested?
Examples
https://bartnikm.github.io/tardis-bartnikm/branch/spectrum_configuration/io/configuration/components/spectrum.html
Type of change
Checklist