Pre_Proccess, Added Intent, Comments, and Formatting

okBrian commented 1 week ago

Description

Added Intent to all subroutine arguments that didn't already have it Added Missing @ param comments on subroutines Formatted Code to be a bit more uniform inline with my how I formatted the Common Directory

Fixes #478

Type of change

[x] Something else

Scope

[x] This PR comprises a set of related changes with a common goal

How Has This Been Tested?

Tested On Github Actions, and Tested Locally

Test Configuration:

Ubuntu 22.04.4 LTS, gcc14 Github Actions

Checklist

[x] I ran ./mfc.sh format before committing my code
[x] New and existing tests pass locally with my changes, including with GPU capability enabled (both NVIDIA hardware with NVHPC compilers and AMD hardware with CRAY compilers) and disabled
[x] This PR does not introduce any repeated code (it follows the DRY principle)
[x] I cannot think of a way to condense this code and reduce any introduced additional line count

sbryngelson commented 1 week ago

looks good. i just found one minor thing to comment on.

on reviewing this PR I'm reminded that i find our use of !-------------- comments after each subroutine statement or function rather silly and a waste of text/space.

Could you do a grep/macro/whatever to delete all of these in a new PR?

okBrian commented 1 week ago

I can remove all the !-------------------- in a new pr.

MFlowCode / MFC