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 #3066 file_list_docs #3067

Merged
merged 6 commits into from
Jan 31, 2025
Merged

Conversation

JohnHalleyGotway
Copy link
Collaborator

@JohnHalleyGotway JohnHalleyGotway commented Jan 28, 2025

Expected Differences

Doc-only change to add details about file lists.

  • 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 and reviewed locally.

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

    Please review the updated docs for this PR for consistency, clarity, and accuracy.

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

  • 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 1/29/25].

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.

@JohnHalleyGotway JohnHalleyGotway linked an issue Jan 28, 2025 that may be closed by this pull request
21 tasks
Copy link
Contributor

@DanielAdriaansen DanielAdriaansen left a comment

Choose a reason for hiding this comment

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

Some changes to increase consistency beyond the consistency you've already added. Otherwise this new section about ASCII file lists is super helpful. Thanks @JohnHalleyGotway!

docs/Users_Guide/data_io.rst Outdated Show resolved Hide resolved
docs/Users_Guide/data_io.rst Outdated Show resolved Hide resolved
docs/Users_Guide/ensemble-stat.rst Outdated Show resolved Hide resolved
docs/Users_Guide/gsi-tools.rst Outdated Show resolved Hide resolved
docs/Users_Guide/reformat_grid.rst Outdated Show resolved Hide resolved
docs/Users_Guide/rmw-analysis.rst Outdated Show resolved Hide resolved
docs/Users_Guide/tc-diag.rst Outdated Show resolved Hide resolved
docs/Users_Guide/tc-rmw.rst Outdated Show resolved Hide resolved
@JohnHalleyGotway
Copy link
Collaborator Author

Thanks for the detailed feedback. I made the requested changes and pushed them for this PR. Please review the updates at your convenience.

Copy link
Contributor

@DanielAdriaansen DanielAdriaansen left a comment

Choose a reason for hiding this comment

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

Just one question only, but otherwise I approve.

@JohnHalleyGotway thanks for making these changes. The minor edits and consistency improvements and new ASCII_FILE_LIST section are great updates to the docs!

docs/Users_Guide/ensemble-stat.rst Show resolved Hide resolved
docs/Users_Guide/mode-td.rst Show resolved Hide resolved
@JohnHalleyGotway JohnHalleyGotway merged commit 8766403 into develop Jan 31, 2025
39 of 40 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 the MET User's Guide to better describe ASCII file lists
2 participants