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 2023 remove double quotes around keywords #2974

Merged
merged 19 commits into from
Sep 16, 2024

Conversation

lisagoodrich
Copy link
Contributor

@lisagoodrich lisagoodrich commented Sep 16, 2024

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:

    John HG provided the below command to run to capture the majority of keywords
for KEYWORD in `cat data/config/ConfigConstants | cut -d'=' -f1 | egrep -v '//' | egrep '[A-Z]' | sort -u`; do
  grep $KEYWORD `find ./ -name "*.rst"`
done

The output from this was captured and put into MET issue #2023 removing double quotes (EVERYTHING). It was 49 pages. Since most of the changes were in the config-options file, the data was broken down into 2 separate sheets:
Config options Copy of MET issue #2023 removing double quotes and Everything else Copy of MET issue #2023 removing double quotes. This second sheet only had 9 changes, and most of those were typos, not keyword double quote issues.

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:
    Please review to make sure that the correct keywords were changed and the typos make sentences easier to read.

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

  • 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 [9/20/24]. This is an artificial date.

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-12.0.0 milestone Sep 16, 2024
@lisagoodrich lisagoodrich linked an issue Sep 16, 2024 that may be closed by this pull request
21 tasks
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 have reviewed the changes (mostly prior to this PR in working with @lisagoodrich) and ensured that all tests passed. @lisagoodrich thank you for your patience and attention to detail on this issue as we weeded through what was a keyword and what was not. Hopefully, this will make the documentation more clear for the users. I approve this request. @lisagoodrich, I'll go ahead and squash and merge for you.

@jprestop jprestop merged commit cf2d724 into develop Sep 16, 2024
3 checks passed
@jprestop jprestop deleted the feature_2023_remove_double_quotes branch September 16, 2024 22: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.

Remove the double-quotes around keywords
2 participants