Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ekluzek opened this issue Feb 2, 2024 · 1 comment

Comments

@ekluzek
Copy link
Contributor

ekluzek commented Feb 2, 2024

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
Copy link
Contributor Author

ekluzek commented Feb 2, 2024

This was started in #74

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant