modify and document user interface; use Bunch #24
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The original Matlab function arguments are not a good match for Python's more flexible argument handling capabilities, so I have sketched out a more pythonic interface for solve and reconstruct, including the docstrings. Given that some option names needed to change, I have made changes freely, opting for longer but more readable names. I have also started using the Bunch more widely; a subsequent step will be to switch much of the internal access from dictionary style to attribute style--which will look more like the original Matlab.
|
See http://currents.soest.hawaii.edu/UTide/html/index.html for the rendered Sphinx docs that go with this PR. This documentation is an important part of the user interface. |
|
@wesleybowman, I think there is a new problem with the confidence interval calculation, and I don't know yet where I introduced it. Let's not merge this yet; I want to see if I can track it down and fix it first. Take a look at the basic design of the PR, including the docs, though, and let me know if you have any objections. |
|
The bug was my fault: I introduced it in 0e948e3. It's fixed now. This PR can be merged if you are comfortable with the direction it is moving. If not, please let me know ASAP. |
|
Very nice work. Great cleanup! |
wesleybowman
added a commit
that referenced
this pull request
Apr 30, 2015
modify and document user interface; use Bunch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The original Matlab function arguments are not a good match for
Python's more flexible argument handling capabilities, so I have
sketched out a more pythonic interface for solve and reconstruct,
including the docstrings. Given that some option names needed
to change, I have made changes freely, opting for longer but
more readable names.
I have also started using the Bunch more widely; a subsequent
step will be to switch much of the internal access from dictionary
style to attribute style--which will look more like the original
Matlab.