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.

Sign up for GitHub

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

Jump to bottom

Enhance MTD documentation so that tables 21.3 and 21.4 have units #2750

Closed
22 tasks
CPKalb opened this issue Nov 28, 2023 · 0 comments · Fixed by #3014
Closed
22 tasks

Enhance MTD documentation so that tables 21.3 and 21.4 have units #2750

CPKalb opened this issue Nov 28, 2023 · 0 comments · Fixed by #3014
Assignees
@JohnHalleyGotway
Labels
alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: documentation Documentation issue requestor: UK Met Office United Kingdom Met Office type: task An actionable item of work
Milestone
MET-12.0.0

Comments

@CPKalb
Copy link
Contributor

CPKalb commented Nov 28, 2023 •
edited by jprestop
Loading

Replace italics below with details for this issue.

Describe the Task

In the MODE documentation, table 19.3 contains the units for MODE output. However, the units are absent from tables 21.3 and 21.4 for the MTD documentation, and need to be added.

This issue arose from the Discussion: MTD documentation and interpreting results for matched objects #2411

Time Estimate

A day or less

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Define the source of funding and account keys here or state NONE.

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Review default alert labels
  • Select component(s)
  • Select priority
  • Select requestor(s)

Milestone and Projects

  • Select Milestone as the next official version or Backlog of Development Ideas
  • For the next official version, select the MET-X.Y.Z Development project

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Milestone as the next official version
    Select: MET-X.Y.Z Development project for development toward the next official release
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@CPKalb CPKalb added component: documentation Documentation issue type: task An actionable item of work alert: NEED MORE DEFINITION Not yet actionable, additional definition required alert: NEED ACCOUNT KEY Need to assign an account key to this issue alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle and removed alert: NEED MORE DEFINITION Not yet actionable, additional definition required labels Nov 28, 2023
@jprestop jprestop added this to the MET 12.0.0 milestone Nov 28, 2023
@jprestop jprestop added requestor: UK Met Office United Kingdom Met Office and removed alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle labels Nov 28, 2023
@JohnHalleyGotway JohnHalleyGotway moved this from 🟢 Ready to 🏗 In progress in MET-12.0.0 Development Nov 12, 2024
JohnHalleyGotway added a commit that referenced this issue Nov 13, 2024
@JohnHalleyGotway
Per #2750, user-provided should be hyphenated.
7c4b1be
JohnHalleyGotway added a commit that referenced this issue Nov 13, 2024
@JohnHalleyGotway
Per #2750, add units to MTD output tables and specify order of foreca…
a00f340 
…st minus observation differences, where applicable. Also update some wording for consistency.
JohnHalleyGotway added a commit that referenced this issue Nov 13, 2024
@JohnHalleyGotway
Unrelated to #2750, but prior to the v12.0.0 release, create a 12.0.0…
cd0534f 
… flowchart, save as PNG, and use it to update the overview figure.
@JohnHalleyGotway JohnHalleyGotway linked a pull request Nov 13, 2024 that will close this issue
Feature #2750 mtd_docs #3014
Merged
17 tasks
@JohnHalleyGotway JohnHalleyGotway moved this from 🏗 In progress to 🔎 In review in MET-12.0.0 Development Nov 13, 2024
JohnHalleyGotway added a commit that referenced this issue Nov 13, 2024
@JohnHalleyGotway
Per #2750, put X_DOT and Y_DOT back on separate lines since RTD inter…
2d4b16b 
…prets X_,Y_DOT as being a poorly defined link.
JohnHalleyGotway added a commit that referenced this issue Nov 14, 2024
@JohnHalleyGotway
Feature #2750 mtd_docs (#3014)
6d69a52 
* Per #2750, user-provided should be hyphenated.

* Per #2750, add units to MTD output tables and specify order of forecast minus observation differences, where applicable. Also update some wording for consistency.

* Unrelated to #2750, but prior to the v12.0.0 release, create a 12.0.0 flowchart, save as PNG, and use it to update the overview figure.

* Per #2750, put X_DOT and Y_DOT back on separate lines since RTD interprets X_,Y_DOT as being a poorly defined link.
@github-project-automation github-project-automation bot moved this from 🔎 In review to 🏁 Done in MET-12.0.0 Development Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JohnHalleyGotway JohnHalleyGotway

Labels
alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: documentation Documentation issue requestor: UK Met Office United Kingdom Met Office type: task An actionable item of work
Projects
No open projects
MET-12.0.0 Development
Status: 🏁 Done
Milestone
MET-12.0.0
Development

Successfully merging a pull request may close this issue.

Feature #2750 mtd_docs dtcenter/MET
3 participants
@jprestop @JohnHalleyGotway @CPKalb