-
Notifications
You must be signed in to change notification settings - Fork 24
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 #2690 tmp_files Contributor's Guide #2693
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… the Contributor's Guide.
Closed
21 tasks
jprestop
approved these changes
Sep 27, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have reviewed the documentation changes and have ensured that all tests passed (noting that the failing check under Check for Differences in unrelated). I approve this request. Thank you for your work on this task.
Closed
21 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Expected Differences
Note that this PR is mainly for documentation changes. It describes MET's use of temporary files in the Contributor's Guide and adds relevant links between the User's Guide and Contributor's Guide. At the MET development meeting on 9/28/23, we'll discuss whether or not additional GitHub issues are warranted to refine MET's use of temporary files.
This PR also:
Note that I added a
Contributor's Guide/dev_details
directory rather than just a singledev_details.rst
file. I anticipate that we'll want to add many development details, and it'll be convenient to organize the content across multiple .rst files rather than putting it all in one for the entire chapter.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:
Rendered and reviewed docs locally.
Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:
Please review the proposed doc changes at https://met--2693.org.readthedocs.build/en/2693/
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 test suite? [No]
If yes, describe the new output and/or changes to the existing output:
No, although GHA testing workflow may continue to flag diffs related to PBL heights computed by PB2NC.
Please complete this pull request review by [Fri 9/29/23].
Pull Request Checklist
See the METplus Workflow for details.
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