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 2949 cxx11 doc #2973

Merged
merged 11 commits into from
Sep 19, 2024
Merged

Feature 2949 cxx11 doc #2973

merged 11 commits into from
Sep 19, 2024

Conversation

jprestop
Copy link
Collaborator

Expected Differences

  • Do these changes introduce new tools, command line arguments, or configuration file options? [Not to the tools, only to the compilation configuration]

    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:

    Reviewed the changes in RTD on the Installation page of my feature branch.

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

    Review the changes and formatting, and suggest any modifications. Ensure all tests pass.

  • 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]

  • 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 [20240920].

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.

@jprestop jprestop added this to the MET-12.0.0 milestone Sep 16, 2024
@jprestop jprestop linked an issue Sep 16, 2024 that may be closed by this pull request
22 tasks
jprestop and others added 3 commits September 16, 2024 15:43
No changes to content, only whitespace for consistency, mostly removing tabs.
Copy link
Collaborator

@JohnHalleyGotway JohnHalleyGotway left a comment

Choose a reason for hiding this comment

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

Julie, I already pushed some whitespace changes and proposed one small change.

I do note that 12.0 appears 20 times in here, and I'm always worried about preventing the docs from looking stale. Should we instead define an env var at the beginning in one spot and then reference it throughout? As the documentation lead, its up to you.

Could be something like

export MET_VERSION=12.0.0

And then reference ${MET_VERSION} in subsequent instructions.

@jprestop
Copy link
Collaborator Author

Julie, I already pushed some whitespace changes and proposed one small change.

I do note that 12.0 appears 20 times in here, and I'm always worried about preventing the docs from looking stale. Should we instead define an env var at the beginning in one spot and then reference it throughout? As the documentation lead, its up to you.

Could be something like

export MET_VERSION=12.0.0

And then reference ${MET_VERSION} in subsequent instructions.

@JohnHalleyGotway I accepted your suggested small change. Thank you for that suggestion!

I agree and had the same concerns. I had talked with @j-opatz and @TaraJensen and they both agreed that the specific version number added clarity and ease for the user. I did update the release notes (and assigned that PR to you also, but I don't think you've had a chance to review it yet) which adds the following under Update Version Number:

In docs/Users_Guide/installation.rst, search for the X.Y version, replacing the current X.Y version with the official X.Y version, if necessary. Pay particular attention to the "Note" about the C++ standard and modify if necessary. The X.Y version number in the "Note" box should NOT change unless the default C++ standard changes.

Let me revisit this and see if I can add a new variable in conf.py for just the X.Y instead of the X.Y.Z with possible "-betaN" or -rcN" because sometimes we need just X.Y. For example:

wget https://raw.githubusercontent.com/dtcenter/MET/main_v12.0/internal/scripts/installation/compile_MET_all.sh

compile_MET_all.sh <https://raw.githubusercontent.com/dtcenter/MET/main_v12.0/internal/scripts/installation/compile_MET_all.sh>_

but, I'm not sure I can successfully replace all of those instances, particularly the links. If not, I can at least reduce the instances of 12.0. I'll follow up once I test some things out. Unless you think that the instructions I added to the release guide are sufficient. Please let me know your thoughts when you get a chance.

Copy link
Collaborator

@JohnHalleyGotway JohnHalleyGotway left a comment

Choose a reason for hiding this comment

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

I approve.

Julie, you're aware of the version-itis challenge, thought through the options, and came to a conclusion. That works for me! Thanks for thinking through the details.

@jprestop
Copy link
Collaborator Author

Thanks @JohnHalleyGotway. Unfortunately, I didn't have the file back in place after testing. When I put it back up, GitHub dismissed your stal review:

jprestop dismissed JohnHalleyGotway’s stale review via 52a0ef4 17 minutes ago

so I need to re-request your review.

@jprestop jprestop merged commit 6053404 into develop Sep 19, 2024
3 checks passed
@jprestop jprestop deleted the feature_2949_cxx11_doc branch September 19, 2024 20:18
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: Provide instructions for compiling MET with the C++11 standard
2 participants