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

Make errors in peakwidths! more friendly #40

Merged
merged 2 commits into from
Apr 11, 2024

Conversation

KronosTheLate
Copy link
Contributor

I encountered one of the errors, and found that it could have been more helpful, and made the changes here.

Related note: would it not be better to add the missing field than to throw an error?

Copy link
Owner

@halleysfifthinc halleysfifthinc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer not to automagically add the missing proms field, I think it is better to force the user to explicitly/consciously call the peakproms function, which will require them to intentionally accept the defaults or choose parameters which are tuned to the user's context/needs. This is also somewhat consistent with the old/explicit API. I

@halleysfifthinc halleysfifthinc merged commit 89acae7 into halleysfifthinc:master Apr 11, 2024
4 checks passed
@KronosTheLate
Copy link
Contributor Author

I had not though about the automagic solution leading to having to choose values for different parameters. That is a very good reason not to do too much. With the added hint, I also feel like there is not that much friction.

Thanks for the quick review!

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

Successfully merging this pull request may close these issues.

2 participants