Skip to content

Change -type for gen_vx_mask from an optional argument to a required one. #1792

@JohnHalleyGotway

Description

@JohnHalleyGotway

Describe the Enhancement

A met-help question revealed that having the -type option for gen_vx_mask as an optional argument with "poly" as the default value causes some confusion. Changing -type from an optional to a required argument would be more clear:
https://rt.rap.ucar.edu/rt/Ticket/Display.html?id=99861

This task is to:

  • Change -type from optional to required.
  • Make sure the resulting error message is clear.
  • Update existing unit tests and add the -type option to them, as needed.
  • Update the documentation to indicate this change.
  • Coordinate with METplus to make sure all the existing use cases still run after this change.

Time Estimate

1 day

Sub-Issues

Consider breaking the enhancement down into sub-issues.
No sub-issue required.

Relevant Deadlines

None

Funding Source

Define the source of funding and account keys here or state NONE.

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Review projects and select relevant Repository and Organization ones or add "alert:NEED PROJECT ASSIGNMENT" label
  • Select milestone to next major version milestone or "Future Versions"

Define Related Issue(s)

Consider the impact to the other METplus components.

Enhancement Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s), Project(s), Milestone, and Linked issues
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions