DART icon indicating copy to clipboard operation
DART copied to clipboard

Doc fix qceff-examples & netcdf inflation files

Open hkershaw-brown opened this issue 1 year ago • 6 comments

Description:

Removes out-of-date reference to quantile-methods branch Removes references to non-existant netcdf_inflation_files.rst (removed in #698)

Fixes issue

fixes #710

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)
  • [x] Documentation update

Documentation changes needed?

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

Tests

Documentation build

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 avatar Aug 07 '24 18:08 hkershaw-brown

Sorry that I didn't respond to this earlier. (I was busy reading these docs and adapting reanalysis branch scripts to use qceff capabilities).

Removing refs to the quantile_methods is good.

I also wondered whether the qceff table replaces the assim_tools_nml method described in the "previous" page, in which case that file should be updated, maybe as part of this PR.

A link to qceff_examples in qceff_probit would have been useful to me, although I found it through a search.

In the qceff_probit.rst and the qceff-examples.rst I recommend changing "anxious" to "eager"

kdraeder avatar Aug 19 '24 19:08 kdraeder

more and more duplicate docs:

https://dart-documentation--711.org.readthedocs.build/en/711/guide/filters.html#filters

hkershaw-brown avatar Aug 19 '24 20:08 hkershaw-brown

and more: https://docs.dart.ucar.edu/en/latest/guide/important-capabilities-dart.html#data-assimilation-algorithms-available-in-dart

hkershaw-brown avatar Aug 19 '24 21:08 hkershaw-brown

more and more duplicate docs:

https://dart-documentation--711.org.readthedocs.build/en/711/guide/filters.html#filters

I was going to approve the PR, but then remembered these 2 notes about duplicates. Are there fixes on the way that I should review?

kdraeder avatar Aug 20 '24 18:08 kdraeder

more and more duplicate docs: https://dart-documentation--711.org.readthedocs.build/en/711/guide/filters.html#filters

I was going to approve the PR, but then remembered these 2 notes about duplicates. Are there fixes on the way that I should review?

yeah let me push em up.

hkershaw-brown avatar Aug 20 '24 18:08 hkershaw-brown

@kdraeder removed filter.rst file (seems pointless) and removed that file from table of contents removed filter_kind assim_tools_nml comment from guide/important-capabilities-dart.rst removed filter_kind from example assim_tools_nmls in: - models/clm/tutorial/README.rst - models/cm1/readme.rst

That was all the filter_kind assim_tools_nml references I could find.

hkershaw-brown avatar Aug 20 '24 18:08 hkershaw-brown