[barrosyan]

Description:

Documentation fixes for obs_common_subset, taken from the list in #808. The reason: the examples in the page contain mistakes that a reader copying them would hit.

• The filelist example shows cat exp2list after creating exp3list; it now shows cat exp3list.
• The filename_seq_list example was missing the opening quote before exp3list.
• "a list of lists of filenames" now says it is a list of files, one per experiment, each containing a list of obs_seq filenames.
• The print_every entry said the count is printed "every Nth set of obs"; it now says it is printed at multiples of print_every.
• The Building section said "Most $DART/models/*/work directories" build the tool; it now names the quickbuild.sh script (the script in those directories is called quickbuild.sh, and the next paragraph already uses that name).

Fixes issue

Fixes #808
moved rest of #808 to #1196

Part of #808. Not addressed here: the obs_selection link item (the :ref: already resolves to the obs_selection page), and the discussion about the Fortran header comment and the error message for differing ensemble sizes, which change code and are better decided by the DART team.

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

Checked the modified file with docutils (no warnings, the namelist table keeps its column widths). I did not build the full Sphinx site.

Checklist for merging

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

(I left the changelog and conf.py items for the team, since the changelog is organized by release tag.)

[hkershaw-brown]

Thanks for this pull request @barrosyan! Some of the team are out of the office over the next few weeks so it might be a little while before we get to this.

[hkershaw-brown]

Approved!
Thanks barrosyan, we'll bundle this with the next release of DART.