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

Bug: do_nexafs and do_rsoxs do not error when arguments do not match expected/known inputs #31

Open
pbeaucage opened this issue Mar 27, 2023 · 2 comments

Comments

@pbeaucage
Copy link
Collaborator

When manually calling do_nexafs and do_rsoxs, there is no checking of whether items in the *args and **kwargs dictionary match expected parameters. A user can therefore invoke

do_rsoxs( ... , pol = 90)
which silently sets the polarization to 0, since the actual argument is polarizations.

It would be good to check and warn if kwargs passed to either function do not match a known parameter, though potentially problematic depending on code structure.

@pbeaucage pbeaucage changed the title Bug: do_nexafs and do_rsoxs do not error when arguments do not match expected Bug: do_nexafs and do_rsoxs do not error when arguments do not match expected/known inputs Mar 27, 2023
@EliotGann
Copy link
Member

these commands are not ever presented as options for actually taking data, and are only provided for super users who should know what the arguments should be, or they should stick with the standard accepted spreadsheet entry. The matching of the spreadsheet entry is a general goal, but the arguments are stricter and should be well understoof before ever using these functions

@EliotGann
Copy link
Member

@pbeaucage do_rsoxs and do_nexafs are not part of this code base, but part of rsoxs can you ask this there or change your issue to add some outside validation options to this package, rather than tying them to the spreadsheet loading?

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

No branches or pull requests

2 participants