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 #2750 mtd_docs #3014

Merged
merged 4 commits into from
Nov 14, 2024
Merged

Feature #2750 mtd_docs #3014

merged 4 commits into from
Nov 14, 2024

Conversation

JohnHalleyGotway
Copy link
Collaborator

@JohnHalleyGotway JohnHalleyGotway commented Nov 13, 2024

Expected Differences

These changes are limited to the docs directory:

  • Update the MTD docs to add information about units and order of differences.

  • Add v12.0.0 flowchart that's just a copy of the v11.1.0 one since no tools have been added or removed.

  • Switch to hyphenated user-provided.

  • 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)? [No]

    If yes, please describe:

Pull Request Testing

  • Describe testing already performed for these changes:

    Built docs locally to confirm they build without warning.

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

Review the documentation updates, primarily in the MTD chapter.
Recommend comparing side-by-side MODE table 19.3 to MTD tables 21.2, 21.3, and 21.4.
Note that I was surprised to find that TIME_CENTROID_DELTA in table 21.4 is computed as observation minus forecast, rather than the other way around as it done elsewhere in MET. But you can see that on this line of code.

  • 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]
    None needed.

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

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

  • Will this PR result in changes to existing METplus Use Cases? [No]

    If yes, create a new Update Truth METplus issue to describe them.

  • Do these changes introduce new SonarQube findings? [No]

    If yes, please describe:

  • Please complete this pull request review by [Wed 11/13/24].

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) and Development issue
    Select: Milestone as the version that will include these changes
    Select: Coordinated METplus-X.Y Support project for bugfix releases or MET-X.Y.Z Development project for official releases
  • After submitting the PR, select the ⚙️ icon in the Development section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
  • 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.

…st minus observation differences, where applicable. Also update some wording for consistency.
… flowchart, save as PNG, and use it to update the overview figure.
@JohnHalleyGotway JohnHalleyGotway added this to the MET-12.0.0 milestone Nov 13, 2024
@JohnHalleyGotway JohnHalleyGotway linked an issue Nov 13, 2024 that may be closed by this pull request
22 tasks
…prets X_,Y_DOT as being a poorly defined link.
Copy link

@CPKalb CPKalb left a comment

Choose a reason for hiding this comment

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

Read through the changes and didn't see any issues

@JohnHalleyGotway JohnHalleyGotway merged commit 6d69a52 into develop Nov 14, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏁 Done
Development

Successfully merging this pull request may close these issues.

Enhance MTD documentation so that tables 21.3 and 21.4 have units
2 participants