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 2716 headers #2725

Merged
merged 23 commits into from
Nov 9, 2023
Merged

Feature 2716 headers #2725

merged 23 commits into from
Nov 9, 2023

Conversation

lisagoodrich
Copy link
Contributor

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

    If yes, please describe:

Pull Request Testing

  • Describe testing already performed for these changes:

    Overall this process went smoothly.
    Most of the headers were already correct. Many of the headers needed to be capitalized to keep our formatting consistent. As usual, there were some exceptions.

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

Please double check all of the index.rst files. I think they are correct but I'd appreciate a second set of eyes on this.
docs/index.rst
docs/Users_Guide/index.rst
docs/Contributors_Guide/index.rst


https://met.readthedocs.io/en/feature_2716_headers/Users_Guide/stat-analysis.html

I think I made the right call on these. I'm leaving them lowercase. Per Julie, this is correct.
16.3.3.1. Job: filter
16.3.3.2. Job: summary
Job: thing_it's_doing_etc.


I didn't capitalize the questions, since they are questions. (But they are also headers so I thought it was worth discussing.)

https://met.readthedocs.io/en/feature_2716_headers/Users_Guide/appendixA.html
Julie: I agree that they should not be capitalized. Thanks for asking about things that aren't clear and where there could be more than one acceptable answer.

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

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

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

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

  • Please complete this pull request review by 11/10/23.

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.

@lisagoodrich lisagoodrich added this to the MET 10.1.3 (bugfix) milestone Nov 6, 2023
@lisagoodrich lisagoodrich linked an issue Nov 6, 2023 that may be closed by this pull request
8 tasks
docs/index.rst Outdated Show resolved Hide resolved
@jprestop
Copy link
Collaborator

jprestop commented Nov 6, 2023

@lisagoodrich I changed the Milestone to MET-12.0.0.

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.

Hi @lisagoodrich. I have requested some changes. When you're finished with the changes and ready for me to re-review, please click on the circular arrow icon next to my name as shown in this screenshot to let me know you're ready for a re-review.
Screen Shot 2023-11-06 at 12 05 14 PM

lisagoodrich and others added 13 commits November 6, 2023 14:23
Co-authored-by: Julie Prestopnik <[email protected]>
@lisagoodrich
Copy link
Contributor Author

@jprestop I have made all of the changes. I think we're good. Do I squash and merge or would you like to do that?

@jprestop
Copy link
Collaborator

jprestop commented Nov 9, 2023

Hi @lisagoodrich. I haven't approved it yet, since I had requested changes. I'll approve it now and will just go ahead and squash and merge for you as I know you're on your way out the door now.

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.

@lisagoodrich Thank you for making these changes and updates. All tests have passed. I approve this request.

@jprestop jprestop merged commit a457fd0 into develop Nov 9, 2023
3 checks passed
@jprestop jprestop deleted the feature_2716_headers branch November 9, 2023 20:33
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.

Documentation: Make Headers Consistent in All MET Guides
2 participants