search

ESCOMP / MOSART

Model for Scale Adaptive River Transport, Mosart, part of the Community Earth System Model
http://www.cesm.ucar.edu/
Other
8 stars 27 forks source link

Simplify PROTEC headers in code to simpler comments to document the flow #86

Closed ekluzek closed 4 months ago

ekluzek commented 8 months ago

MOSART was originally coded with PROTEC headers. PROTEC provides a way to self document code, by adding a processor that turns it into documentation. We never utilized this in MOSART, and only did a long time ago in CTSM. We didn't feel the PROTEC documentation added enough to keep it updated and working.

So we might as well remove it in MOSART and simplify into comments that still document sections of the code and visually divide the code into those sections as well as provide the same functionality of documenting what's going on. But, without using the specific PROTEC syntax.

ekluzek commented 8 months ago

This was started in #74

mvertens commented 4 months ago

This has already been done by #76