Skip to content

Renames#1299

Merged
dopplershift merged 18 commits into
Unidata:masterfrom
dopplershift:renames
Jan 13, 2020
Merged

Renames#1299
dopplershift merged 18 commits into
Unidata:masterfrom
dopplershift:renames

Conversation

@dopplershift
Copy link
Copy Markdown
Member

Description Of Changes

  • Renames a bunch of function arguments to make things consistent, remove abbreviations/symbols in favor of full, conceptual names.
  • Also re-orders some of the moisture functions to consistently use: pressure -> temperature -> moisture.
  • Updates Contributor's Guide with this information

Checklist

@dopplershift dopplershift added this to the 1.0 milestone Jan 13, 2020
@dopplershift dopplershift added Area: Calc Pertains to calculations Type: Enhancement Enhancement to existing functionality labels Jan 13, 2020
Copy link
Copy Markdown
Collaborator

@jthielen jthielen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally looks good to me! Just a couple things I noticed going through this:

Comment thread CONTRIBUTING.md Outdated
Comment thread src/metpy/calc/indices.py Outdated
@preprocess_xarray
@check_units('[pressure]', '[speed]', '[speed]', '[length]', '[speed]', '[speed]')
def critical_angle(pressure, u, v, heights, stormu, stormv):
def critical_angle(pressure, u, v, height, stormu, stormv):
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a signature to keep as-is? The two things that stood out to me as unexpected (based on the new quasi-standard) are:

  • having the two different velocity component pairs separated by the height argument
  • stormu and stormv might be better as u_storm and v_storm

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@jthielen
Copy link
Copy Markdown
Collaborator

Also, it looks like the argument order swap in relative_humidity_from_specific_humidity wasn't updated in examples/cross_section.py.

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: Enhancement Enhancement to existing functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Naming consistency

2 participants