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

Fix broken use case documentation page for 3.1 #729

Closed
11 of 21 tasks
georgemccabe opened this issue Dec 10, 2020 · 0 comments · Fixed by #730
Closed
11 of 21 tasks

Fix broken use case documentation page for 3.1 #729

georgemccabe opened this issue Dec 10, 2020 · 0 comments · Fixed by #730
Assignees
Labels
component: documentation Documentation issue priority: high High Priority requestor: NCAR National Center for Atmospheric Research type: bug Fix something that is not working

Comments

@georgemccabe
Copy link
Collaborator

The model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_IVT.conf use case is formatted incorrectly so it displays "SyntaxError" as the title of the page instead of the actual title. This was fixed in the develop branch but the current docs displayed for 3.1 (latest) still show the error.

A patch to the main_v3.1 branch and render of the documentation on the web should be done, but a bugfix release is not necessary for this change.

Describe the Problem

The main_v3.1 branch and web documentation should be fixed.

Expected Behavior

The title for this use case should be the actual title of the case, not SyntaxError

https://dtcenter.github.io/METplus/latest/generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_IVT.html#sphx-glr-generated-model-applications-medium-range-tcstat-seriesanalysis-fcstgfs-obsgfs-featurerelative-seriesbylead-pyembed-ivt-py

Relevant Deadlines

None

Funding Source

None

Define the Metadata

Assignee

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

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Review projects and select relevant Repository and Organization ones or add "alert:NEED PROJECT ASSIGNMENT" label
  • Select milestone to relevant bugfix version

Define Related Issue(s)

Consider the impact to the other METplus components.

Bugfix 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 main_<Version>.
    Branch name: bugfix_<Issue Number>_main_<Version>_<Description>
  • Fix the bug and test your changes.
  • Add/update log messages for easier debugging. N/A
  • Add/update unit tests. N/A
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into main_<Version>.
    Pull request: bugfix <Issue Number> main_<Version> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s), Project(s), Milestone, and Linked issues
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Complete the steps above to fix the bug on the develop branch. N/A - already completed
    Branch name: bugfix_<Issue Number>_develop_<Description>
    Pull request: bugfix <Issue Number> develop <Description>
  • Close this issue.
@georgemccabe georgemccabe added type: bug Fix something that is not working component: documentation Documentation issue priority: high High Priority requestor: NCAR National Center for Atmospheric Research labels Dec 10, 2020
@georgemccabe georgemccabe added this to the METplus-3.1.1 Bugfix milestone Dec 10, 2020
@georgemccabe georgemccabe self-assigned this Dec 10, 2020
@georgemccabe georgemccabe linked a pull request Dec 10, 2020 that will close this issue
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: high High Priority requestor: NCAR National Center for Atmospheric Research type: bug Fix something that is not working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant