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 obs_diag ranked histogram documentation links #695

Merged
merged 3 commits into from
Jul 11, 2024

Conversation

c-merchant
Copy link
Collaborator

Description:

This is a fix to the documentation links for guidance on creating ranked histograms with ncview and matlab for threed_cartesian and threed_sphere obs_diag. They link to the documentation for ncview and the guide on analyzing observation space with MATLAB.

Fixes issue

Issue #657

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Documentation changes needed?

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Tests

I built and ran the DART documentation locally with Sphinx and ran the classic ./quickbuild.sh to make sure things hadn't been thrown off.

Checklist for merging

  • Updated changelog entry
  • Documentation updated
  • Update conf.py

Checklist for release

  • Merge into main
  • Create release from the main branch with appropriate tag
  • Delete feature-branch

Testing Datasets

  • Dataset needed for testing available upon request
  • Dataset download instructions included
  • No dataset needed

@hkershaw-brown
Copy link
Member

Thanks Charlotte, the fix looks good.
As you mentioned there's a commit history with a few experiments here, I'm going to go ahead and squash the commits to keep tidy.

The obs_diag pages all have a broken link to 'ncview' at the bottom of each page, I'll switch this out with the working link since I'm squashing.

This is out of scope for this request, but there is loads of repeated documentation between these pages:

PROGRAM obs_diag (for 1D observations)
PROGRAM obs_diag (for observations that use the threed_cartesian location module)
PROGRAM obs_diag (for observations that use the threed_sphere location module)

fix broken link to ncview in text
removed underscores from anchor, rst seemed to not like these

see https://github.com/NCAR/DART/pull/695/files#r1668667022
and https://github.com/NCAR/DART/pull/695/files#r1668706724 for discusion

link to anchor rather than hardoded html page.
@hkershaw-brown
Copy link
Member

@c-merchant I switched out the hardcoded links from https://docs.dart.ucar.edu/en/latest/guide/matlab-observation-space.html to the anchor for plot_rank_histogram can you give this a review.

Cheers
Helen

@hkershaw-brown hkershaw-brown added the release! bundle with next release label Jul 8, 2024
@c-merchant
Copy link
Collaborator Author

c-merchant commented Jul 8, 2024

@hkershaw-brown Got it. I checked the links, and they look good to go!
Best,
Charlotte

Copy link
Member

@hkershaw-brown hkershaw-brown left a comment

Choose a reason for hiding this comment

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

Thanks Charlotte!

@hkershaw-brown hkershaw-brown merged commit b825400 into NCAR:main Jul 11, 2024
4 checks passed
@c-merchant c-merchant deleted the fix-diag-doc-links branch July 23, 2024 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release! bundle with next release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants