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

Feature #2337 DIAG_SOURCE #2338

Merged
merged 3 commits into from
Nov 10, 2022
Merged

Conversation

JohnHalleyGotway
Copy link
Collaborator

Expected Differences

  • Do these changes introduce new tools, command line arguments, or configuration file options? [No]

    If yes, please describe:

  • Do these changes modify the structure of existing or add new output data types (e.g. statistic line types or NetCDF variables)? [Yes]

    If yes, please describe:

    Renames the TCDIAG SOURCE column as DIAG_SOURCE.

Pull Request Testing

  • Describe testing already performed for these changes:

    None.

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

  • @venitahagerty please review to confirm that the DIAG_SOURCE naming convention matches what you're adding to METdataio.

  • @jprestop please review the documentation updates I'm making here. The GHA tests should all run but differences will likely be flagged based on the modified column name. The data values should remain unchanged.

  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]

  • Do these changes include sufficient testing updates? [Yes]

  • Will this PR result in changes to the test suite? [Yes]

    If yes, describe the new output and/or changes to the existing output:

    Changes output column name from SOURCE to DIAG_SOURCE but the actual data value SHOULD NOT change.

  • Please complete this pull request review by [Thurs 11/10/22].

Pull Request Checklist

See the METplus Workflow for details.

  • Review the source issue metadata (required labels, projects, and milestone).
  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    Select: Reviewer(s)
    Select: Organization level software support Project or Repository level development cycle Project
    Select: Milestone as the version that will include these changes
  • After submitting the PR, select Development with the original issue number.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

@JohnHalleyGotway JohnHalleyGotway added this to the MET 11.0.0 milestone Nov 9, 2022
@JohnHalleyGotway JohnHalleyGotway linked an issue Nov 9, 2022 that may be closed by this pull request
20 tasks
Copy link

@venitahagerty venitahagerty left a comment

Choose a reason for hiding this comment

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

I confirmed that the MET use of DIAG_SOURCE matches METdataio use of diag_source

@JohnHalleyGotway
Copy link
Collaborator Author

@jprestop I checked this morning and see that GHA did NOT flag the modified output column name as being a difference. Thinking about the logic of the diffing code, I understand why not. So that's good news in some ways... these changes caused no unintended consequences.

But it also does remind me how we really need to revise that differencing logic!

Copy link
Collaborator

@jprestop jprestop left a comment

Choose a reason for hiding this comment

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

I reviewed the documentation updates, and they look great! Thanks for letting me know that GHA did NOT flag the modified output column name as being a difference, and I'm glad that you understand why. I agree that it makes sense to revise the differencing logic! I approve this PR.

@JohnHalleyGotway JohnHalleyGotway merged commit 86958e7 into develop Nov 10, 2022
@JohnHalleyGotway JohnHalleyGotway deleted the feature_2337_DIAG_SOURCE branch February 28, 2023 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Rename the TCDIAG SOURCE column as DIAG_SOURCE
3 participants