Skip to content

Conversation

@Jon-Lillis
Copy link
Collaborator

@Jon-Lillis Jon-Lillis commented Jan 13, 2026

Closes #84.

PR creation checklist for the developer

  • Has <issue_number> above ☝️ been replaced with the issue number?
  • Has main been selected as the base branch?
  • Does the feature branch name follow the format <issue_number>_<short_description_of_feature>?
  • Does the text of the PR title exactly match with the text (not including the issue number) of the issue title?
  • Have appropriate reviewers been added to the PR (once it is ready for review)?
  • Has the PR been assigned to the developer(s)?
  • Have the same labels as on the issue (except for the good first issue label) been added to the PR?
  • Has the Climate Model Evaluation Workflow (CMEW) project been added to the PR?
  • Has the appropriate milestone been added to the PR?

Definition of Done for the developer

  • Does the change in this PR address the above issue / have all acceptance criteria been met?
  • Does the change in this PR follow the requirements in the wiki: Developer Guide (including copyrights)?
  • Have new tests related to the change been added?
  • Do all the GitHub workflow checks pass?
  • Do all the tests run locally and pass? (Note: the tests are not run by the GitHub workflow, see wiki: Run the tests locally)
  • Has the API documentation (e.g. docstrings in Python modules) related to the change been updated appropriately?
  • Has the user documentation (i.e. everything in the doc directory) related to the change been updated appropriately, including the Quick Start section?
  • Do the HTML pages render correctly? (See wiki: Build the documentation locally)

PR creation checklist for the reviewer

  • Has <issue_number> above ☝️ been replaced with the issue number?
  • Has main been selected as the base branch?
  • Does the feature branch name follow the format <issue_number>_<short_description_of_feature>?
  • Does the text of the PR title exactly match with the text (not including the issue number) of the issue title?
  • Have appropriate reviewers been added to the PR (once it is ready for review)?
  • Has the PR been assigned to the developer(s)?
  • Have the same labels as on the issue (except for the good first issue label) been added to the PR?
  • Has the Climate Model Evaluation Workflow (CMEW) project been added to the PR?
  • Has the appropriate milestone been added to the PR?

Definition of Done for the reviewer

  • Does the change in this PR address the above issue / have all acceptance criteria been met?
  • Does the change in this PR follow the requirements in the wiki: Developer Guide (including copyrights)?
  • Have new tests related to the change been added? N/A
  • Do all the GitHub workflow checks pass?
  • Do all the tests run locally and pass? (Note: the tests are not run by the GitHub workflow, see wiki: Run the tests locally)
  • Has the API documentation (e.g. docstrings in Python modules) related to the change been updated appropriately? N/A
  • Has the user documentation (i.e. everything in the doc directory) related to the change been updated appropriately, including the Quick Start section?
  • Do the HTML pages render correctly? (See wiki: Build the documentation locally)

@Jon-Lillis Jon-Lillis linked an issue Jan 13, 2026 that may be closed by this pull request
@Jon-Lillis Jon-Lillis self-assigned this Jan 13, 2026
@Jon-Lillis Jon-Lillis added the documentation Improvements or additions to documentation label Jan 13, 2026
@Jon-Lillis Jon-Lillis changed the title Mdd metric, recipe, and assessment area to the glossary Add metric, recipe, and assessment area to the glossary Jan 13, 2026
@mo-nikosbaltas mo-nikosbaltas self-requested a review January 14, 2026 10:18

.. glossary::

Assessment Area
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please replace in line -1: 2022-2025 with 2022-2026

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Addressed in 390f649.

Copy link
Collaborator

@mo-nikosbaltas mo-nikosbaltas left a comment

Choose a reason for hiding this comment

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

Can you change the '.. (C) Crown Copyright 2022-2025, Met Office.' to 2022-2026 for all the other .rst files?

@mo-nikosbaltas
Copy link
Collaborator

Sorry, not all the .rst files only the ones you had changed.

@mo-nikosbaltas
Copy link
Collaborator

Can you add the appropriate milestone to the PR

@Jon-Lillis
Copy link
Collaborator Author

Thanks for catching the copyright statements. All corrected and ready for re-review.

mo-nikosbaltas
mo-nikosbaltas previously approved these changes Jan 15, 2026
Copy link
Collaborator

@mo-nikosbaltas mo-nikosbaltas left a comment

Choose a reason for hiding this comment

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

All looks good. Approved.

Copy link
Member

@ehogan ehogan left a comment

Choose a reason for hiding this comment

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

Thanks @Jon-Lillis 🥳

Would it be possible for you to add pipes around all instances of metric, recipe and assessment area in the documentation, including in the glossary, please? 😊

Copy link
Member

@ehogan ehogan left a comment

Choose a reason for hiding this comment

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

Please also:

  • Ensure the text of the PR title exactly matches with the text (not including the issue number) of the issue title

@Jon-Lillis Jon-Lillis changed the title Add metric, recipe, and assessment area to the glossary Add "metric", "recipe", and "assessment area" to the glossary Jan 20, 2026
@Jon-Lillis
Copy link
Collaborator Author

Thanks @Jon-Lillis 🥳

Would it be possible for you to add pipes around all instances of metric, recipe and assessment area in the documentation, including in the glossary, please? 😊

Added in 2718624.

@Jon-Lillis
Copy link
Collaborator Author

Please also:

* Ensure the text of the PR title **exactly** matches with the text (not including the issue number) of the issue title

Quotes added to the title.

@ehogan
Copy link
Member

ehogan commented Jan 22, 2026

Thanks @Jon-Lillis 🥳
Would it be possible for you to add pipes around all instances of metric, recipe and assessment area in the documentation, including in the glossary, please? 😊

Added in 2718624.

Would it be possible to also do this for metric and assessment area, please 😊

@ehogan
Copy link
Member

ehogan commented Jan 22, 2026

Please also:

  • Ensure the text of the PR title exactly matches with the text (not including the issue number) of the issue title

Quotes added to the title.

There's also an extra command after "recipe" 🤪

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add "metric", "recipe" and "assessment area" to the glossary

4 participants