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

Create anchors for MET variable in MET User's Guide #1811

Closed
13 of 21 tasks
jprestop opened this issue May 25, 2021 · 2 comments · Fixed by #1822
Closed
13 of 21 tasks

Create anchors for MET variable in MET User's Guide #1811

jprestop opened this issue May 25, 2021 · 2 comments · Fixed by #1822
Assignees
Labels
component: documentation Documentation issue component: user support User support issue priority: low Low Priority reporting: DTC NCAR Base NCAR Base DTC Project requestor: METplus Team METplus Development Team type: task An actionable item of work
Milestone

Comments

@jprestop
Copy link
Collaborator

jprestop commented May 25, 2021

Describe the Task

Create anchors for MET variable in MET User's Guide. On these pages:
https://met.readthedocs.io/en/latest/Users_Guide/config_options.html#config-options
https://met.readthedocs.io/en/latest/Users_Guide/config_options.html#settings-specific-to-individual-tools
create anchors for the numerous variables that are bolded without creating section headers for each variable.

Time Estimate

1 to 3 days of work

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

None; self-imposed; see selection in Projects/Milestones

Funding Source

2702691

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

  • Select Repository and/or Organization level Project(s) or add alert: NEED PROJECT ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

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 Linked issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@jprestop jprestop added component: documentation Documentation issue component: user support User support issue type: task An actionable item of work priority: low Low Priority alert: NEED ACCOUNT KEY Need to assign an account key to this issue requestor: METplus Team METplus Development Team labels May 25, 2021
@jprestop jprestop added this to the MET 10.1.0 milestone May 25, 2021
@jprestop jprestop added this to To do in MET-10.1.0-beta1 (6/13/21) via automation May 25, 2021
@jprestop
Copy link
Collaborator Author

This is how existing internal links are referenced:
On thispage, exists this sentence:

Common statistics that use a climatological reference include: the mean squared error skill score (MSESS), the Anomaly Correlation (ANOM_CORR and ANOM_CORR_UNCNTR), scalar and vector anomalies (SAL1L2 and VAL1L2), continuous ranked probability skill score (CRPSS and CRPSS_EMP), Brier Skill Score (BSS) (Wilks, 2011; Mason, 2004).

The point-stat.rst file has the following syntax for the Mason reference:

:ref:`Mason, 2004 <Mason-2004>`

And, ref.rst has the following syntax to enable linking to this Mason reference:

.. _Mason-2004:

| Mason, S. J., 2004: On Using "Climatology" as a Reference Strategy
| in the Brier and Ranked Probability Skill Scores. Monthly Weather Review,
| 132, 1891-1895.

However, this does not have all of the functionality we would like. We would like a link to Mason, so that it can be easily referenced by a developer to give to a user so that the developer does not have to go into the .rst file to see what the header is to link to. In the above example the link is:

https://met.readthedocs.io/en/latest/Users_Guide/refs.html#mason-2004

However, the developer would not know to add "#mason-2004" to the link without looking at the .rst file. The link reference needs to be visible and easily obtainable.

This page may have some guidance on how to proceed:

https://stackoverflow.com/questions/30822880/python-sphinx-anchor-on-arbitrary-line

Please scroll down to the following text:

EDIT:
There is one more option. This will create an anchor and the hover effect.

and try that method out to see if it gives us what we want. If that doesn't give us what we want, we'll need to do some further digging, but don't spend too much time on it.

@TaraJensen TaraJensen added reporting: DTC NCAR Base NCAR Base DTC Project and removed alert: NEED ACCOUNT KEY Need to assign an account key to this issue labels May 25, 2021
@lisagoodrich
Copy link
Contributor

We ended up using the reference links above. If the link is clicked on, the full address will appear in the web address and can be copied from there.

@JohnHalleyGotway JohnHalleyGotway linked a pull request Jun 11, 2021 that will close this issue
12 tasks
@JohnHalleyGotway JohnHalleyGotway moved this from To do to Done in MET-10.1.0-beta1 (6/13/21) Jun 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue component: user support User support issue priority: low Low Priority reporting: DTC NCAR Base NCAR Base DTC Project requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

4 participants