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

Instrument options keyword argument doesn't validate option names #24

Closed
josePhoenix opened this issue Nov 14, 2014 · 2 comments
Closed
Labels
Milestone

Comments

@josePhoenix
Copy link
Collaborator

Passing in instrument.options['foo'] doesn't validate that 'foo' is actually an option provided by WebbPSF/POPPY. Also, I am told we don't have clear documentation of all the available options.

Ideally, we'd validate that options provided by the user are really allowed. I need to look at where the options dict goes in its path through the code and see if that's feasible. This may not be an easy fix, but it's worth mentioning so we're at least aware users are getting tripped up by it.

@mperrin
Copy link
Owner

mperrin commented Nov 17, 2014

To be documented better - no validation intentionally since sub optics can expose who knows what options.

Agreed this would be over engineering at this stage - but let's doc better.

@mperrin mperrin added the docs label Nov 17, 2014
@josePhoenix josePhoenix mentioned this issue Nov 24, 2014
15 tasks
josePhoenix pushed a commit to josePhoenix/webbpsf that referenced this issue Nov 25, 2014
@josePhoenix josePhoenix modified the milestone: 0.3 Dec 11, 2014
@josePhoenix
Copy link
Collaborator Author

closed by d47b774

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

No branches or pull requests

2 participants