-
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 2949 cxx11 doc #2973
Feature 2949 cxx11 doc #2973
Conversation
No changes to content, only whitespace for consistency, mostly removing tabs.
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.
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.
Co-authored-by: John Halley Gotway <[email protected]>
@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:
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:
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. |
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 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.
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:
so I need to re-request your review. |
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.
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