Skip to content

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

Closed

Description

@ekluzek

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.

Activity

  1. ekluzek commented on Feb 2, 2024

    @ekluzek
    ContributorAuthor

    This was started in #74

  2. mvertens commented on Jun 7, 2024

    @mvertens
    Contributor

    This has already been done by #76

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions