run_tower and run_tower.py docstrings have drifted
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 65/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- fortran
- Domain
- documentation
Research direction
Find the run_tower and run_tower.py docstrings and compare their overlapping content. Start by reading both; the issue suggests trimming the wrapper's docstring to reduce duplicated information. Done means the two docstrings no longer duplicate confusing information and accurately direct readers to the relevant details.
Written by the indexing model from the issue text.
Description
(Please see our contribution guidelines for documentation.)
What sort(s) of documentation issue is this?
- Something is missing.
- Something is (or might be) incorrect or outdated.
- Something is confusing.
- Something is broken.
What part(s) of the documentation does this concern?
- Technical Note (science and design of the model)
- User's Guide (using the model and related tools)
- Somewhere else (e.g., README file, tool help text, or code comment): Please specify
- I don't know
Describe the issue
The run_tower and run_tower.py docstrings have drifted. There is lots of duplicated information, making this easy to happen. I suggest trimming from run_tower, which is just a wrapper.
- Dominant language
- Fortran
- Stars
- 353
- Forks
- 368
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 12
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
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.
More from ESCOMP/CTSM
-
b4b usability
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
b4b good first issue size: small test: python usability
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Maintainers usually reply within 1 day
-
Indicate why we have two variables for snow cover fraction (frac_sno_albedo and frac_sno_fluxes) and when they are different.May be free again @olyson claimed this 31 days ago, and no pull request is open. Openb4b docs-loc:tech-note documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
ESCOMP/CTSM#4219 · 1 comment · 2 assignees ·
Maintainers usually reply within 1 day
-
Change "Spinup" compsets to "Cplhist"May be free again @slevis-lmwg claimed this 31 days ago, and no pull request is open. Openb4b usability
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
ESCOMP/CTSM#4218 · 2 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
Only test CISM with the latest CLM physics (currently clm6_0)May be free again @ekluzek claimed this 53 days ago, and no pull request is open. Openb4b testing
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ESCOMP/CTSM#4168 · 2 comments · 2 assignees ·
Maintainers usually reply within 1 day
Similar issues
-
content triage
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
graph-2026-11-simplify
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
sequant-io/sequant#1650 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
Maintainers usually reply within 1 day