NCAR / NCAR/DART

Documentation: obs_common_subset typos, corrections

Open
#808 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

back burner Good First Issue
Dominant language
Fortran
Stars
263
Forks
182
Avg merge
11d 12h
Merged PRs (30d)
7

Description

What's the issue?

📚 obs_common_subset.html has several minor mistakes I'd like to note as I'm reading.

Where did you find the issue?

assimilation_code/programs/obs_common_subset/obs_common_subset.html
https://docs.dart.ucar.edu/en/latest/assimilation_code/programs/obs_common_subset/obs_common_subset.html#program-obs-common-subset

What needs to be fixed?

"obs_selection_tool" is named "obs_selection", and the text is not a link.

"list of lists of filenames" would be clearer as "list of files, each containing a list of obs_seq files"

ls exp3/*/obs_seq.final > exp3list
cat exp2list

filename_seq_list = 'exp1list', 'exp2list', exp3list' Needs a ' before exp3list

In the table of namelist entries we might want to change "printed every Nth set of obs"
to "printed at multiples of print_every"

Building: "Most $DART/models/*/work directories" would more accurately (but less robustly) be
"Most $DART/models/*/work/quick_build.sh"

Anything else we should know?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open assimilation_code/programs/obs_common_subset/obs_common_subset.html and review the listed wording, link, command, quoting, table, and build-path corrections. Done when each requested correction is applied and the linked obs_common_subset documentation page shows the revised text.

Written by the indexing model from the issue text.

Assessment

Tech stack
fortran
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.