NCAR / NCAR/CAM

Need to update nhtfrq description in gh-pages branch

Open Beginner friendly
#14 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: documentation
Dominant language
No language data
Stars
1
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Currently the description for the namelist variable nhtfrq in the CAM User's Guide states that only the first history file can contain monthly averages. However, this is not actually the case, and appears to be causing some confusion with a few users. Thus the HTML documentation should be updated to remove this "first file" statement.

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

In the gh-pages branch, locate the HTML CAM User's Guide entry for the namelist variable nhtfrq. Read the current description and remove the statement that only the first history file can contain monthly averages. Done means the rendered documentation no longer makes that claim.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.