Skip to content
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

JOSS Review: Instructions on Contributing Curves and Minor Comments #222

Closed
TheSkyentist opened this issue Aug 9, 2024 · 3 comments · Fixed by #224
Closed

JOSS Review: Instructions on Contributing Curves and Minor Comments #222

TheSkyentist opened this issue Aug 9, 2024 · 3 comments · Fixed by #224

Comments

@TheSkyentist
Copy link

TheSkyentist commented Aug 9, 2024

This is a part of openjournals/joss-reviews#7023

The purpose, documentation, and examples for the code are all well described in the JOSS submission. The code is installable, flexible, and useful for current and future astronomical analysis.

One of the most useful parts is the vast array of extinction models available to the end user, with the ability for contributing more as stated as one of the strengths of the code in the final sentence of the draft. As this is a stated feature of the code:

  1. Would it be possible to add documentation on the format required for an extinction curve that could be merged into the repository?
  2. Or, equally, to add documentation to the meta-classes to enable an end user to easily create "on-the-fly" extinction curves.

I believe that this would satisfy the Documentation Community Guidelines section of the JOSS checklist.

In addition, I have a few minor comments on the draft around language:

  1. Line 6, it might sound better by removing the first instance of word "photon".
  2. Line 30, I believe the units A(lambda) should be explicitly stated here as magnitudes.
  3. Line 36, would it be possible to change "like" to "such as", as the former sounds conversational.
@karllark
Copy link
Owner

karllark commented Aug 9, 2024

All good suggestions. I will work to get these done ASAP.

@karllark
Copy link
Owner

For the comments on the text of the paper.

  1. I've not removed the first photon. The reason is that with only the 2nd photon it reads as "absorbing photons out of the line-of-sight." This is not correct. I agree that it is a bit awkward, but it is more accurate.
  2. Done.
  3. Done.

@karllark
Copy link
Owner

If you find that #224 does not address this issue fully, please reopen this issue (once it is closed by merging the PR).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants