clarifications for the "How DART stores observations" documentation
Nobody has claimed this yet.
- Dominant language
- Fortran
- Stars
- 263
- Forks
- 182
- Avg merge
- 11d 12h
- Merged PRs (30d)
- 7
Description
This page:
https://docs.dart.ucar.edu/en/latest/guide/introduction-obs-seq-file.html
-
The sentence "An obs_seq.in file actually contains no observation quantities." seems a bit misleading. The file does include the type of observation, just not the value. Maybe reword to clarify that, particularly with the use of quantities as 'physical quantities' for QCEFF.
-
The explanation of the linked list structure only mentions obs_seq.out, but all obs_seq.X files use a linked list. It might help to make that more general.
-
The word "notebook" might confuse readers since people usually think of Jupyter notebooks nowadays. A different term could make things clearer.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked How DART stores observations page and locate its documentation source in the repository. Review the passages about observation quantities, linked lists, and the term “notebook,” then revise them for the stated clarifications and preview the page to confirm the wording is clear.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100