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

Consider re-ordering arguments for precipitable_water #1235

Closed
dopplershift opened this issue Nov 16, 2019 · 2 comments · Fixed by #1244
Closed

Consider re-ordering arguments for precipitable_water #1235

dopplershift opened this issue Nov 16, 2019 · 2 comments · Fixed by #1244
Labels
Area: Calc Pertains to calculations Type: API Change Changes to how existing functionality works Type: Enhancement Enhancement to existing functionality
Milestone

Comments

@dopplershift
Copy link
Member

So the call for precipitable water is:

precipitable_water(dewpt, pressure, bottom=None, top=None)

We should probably considering changing this to:

precipitable_water(pressure, dewpt, *, bottom=None, top=None)

This is re-ordering the first two arguments for consistency. The other is to change (now that we're on Python 3) to make bottom and top kwarg-only.

@dopplershift dopplershift added Area: Calc Pertains to calculations Type: API Change Changes to how existing functionality works Type: Enhancement Enhancement to existing functionality labels Nov 16, 2019
@dopplershift dopplershift added this to the 0.12 milestone Nov 16, 2019
@dopplershift
Copy link
Member Author

Marking 0.12 to put in a shim in future to allow using it in 0.12.

@dopplershift
Copy link
Member Author

We may also want to consider doing this for storm_relative_helicity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Calc Pertains to calculations Type: API Change Changes to how existing functionality works Type: Enhancement Enhancement to existing functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant