run_tower and run_tower.py docstrings have drifted

Aperta Adatta ai principianti
#4,306 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
65/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
fortran
Ambito
documentation

Direzione di ricerca

Trova i docstring di run_tower e run_tower.py e confronta i contenuti sovrapposti. Inizia leggendo entrambi; l’issue suggerisce di accorciare il docstring del wrapper per ridurre le informazioni duplicate. Il lavoro è concluso quando i due docstring non duplicano più informazioni fuorvianti e indirizzano correttamente i lettori ai dettagli pertinenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

b4b docs-loc:codebase docs:minor-content-fix documentation

(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.

Lingua principale
Fortran
Stelle
353
Fork
368
Merge medio
2g 15h
PR unite (30g)
12

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ESCOMP/CTSM

Tutte le issue di ESCOMP/CTSM

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.