NOAA-EMC / global-workflow

Global Superstructure/Workflow supporting the Global Forecast System (GFS)
https://global-workflow.readthedocs.io/en/latest
GNU Lesser General Public License v3.0
75 stars 170 forks source link

Improve inline documentation #299

Open WalterKolczynski-NOAA opened 3 years ago

WalterKolczynski-NOAA commented 3 years ago

This is an umbrella issue to both monitor the progress of updating docblocks from packages used by global-workflow and updates of scripts owned by g-w itself. This issue should link to the corresponding GitHub issues in the offending packages to ensure all are addressing this issue.

Jen Yang 2021-03-12 06:21:42 UTC It is required that all the production code/scripts have meaningful document blocks. Scanned the gfs package and at least saw following scripts has no document or not enough detail document. Please check those and review the other scripts and source code for improvement.

gldas_liscrd.sh gldas_process_data.sh load_fv3gfs_modules.sh mod_icec.sh - has some comment but need more detail parse-storm-type.pl trim_rh.sh - has some comment but need more detail wafs_grib2.regrid.sh

This can be addressed in next major upgrade.

Refs: Bugzilla #1217

arunchawla-NOAA commented 1 year ago

What is the status of this issue? @WalterKolczynski-NOAA, @KateFriedman-NOAA and @WalterKolczynski-NOAA ? Can we create a template doc block that all scripts need to follow and create individual issues for each script to implement that doc block? We can then track them as a project