-
Notifications
You must be signed in to change notification settings - Fork 31
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
Options refactoring and docs update #38
Conversation
After further discussion, we have decided to change the capitalization of the accepted |
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.
I think this one is ready right @eirikurj?
Purpose
This PR refactors the code to:
The option type and value checking in BaseSolver breaks backward compatibility for some run scripts. This is usually only an issue for
fileType
because string-type values are now case sensitive. The actually functionality is unchanged.The tutorial run scripts should be fine, but this will break the tests for:
Once this is merged, the maintainers should make a new release and make these incompatibilities clear in the release notes. Here is an example.
One note for those more familiar with the code: PLOT3D mesh format looks like it is supported, but this is not mentioned anywhere in the options docs and is not tested. I have excluded
plot3d
from thefileType
option for now. Let me know if I should add it.Type of change
What types of change is it?
Select the appropriate type(s) that describe this PR
Testing
See the BaseSolver tests for examples on how the type and value checking works.
Checklist
Put an
x
in the boxes that apply.flake8
andblack
to make sure the code adheres to PEP-8 and is consistently formatted