Fix #171, Remove function names from function header comments and clean up empty lines.#172
Fix #171, Remove function names from function header comments and clean up empty lines.#172thnkslprpt wants to merge 3 commits intonasa:mainfrom
Conversation
jphickey
left a comment
There was a problem hiding this comment.
Although I'm OK with removing the function name from comment blocks, we should not be removing the comment block in its entirety - this is important to get some visual distinction of where a function starts as one is scrolling through a file. I believe GSFC coding standards do require some sort of block comment at the definition of each function, but what actually goes in it can vary.
As far as blank lines goes, I defer to what clang-format rules dictate - if these rules allow a blank line to be there, then AFAIAC the blank line can stay. It will remove extra lines if there are more than allowed.
a8dc24b to
7fe6513
Compare
|
I totally agree they make it easier to identify each function when scrolling through - added the empty ones back now. |
7fe6513 to
ba94e8c
Compare
Checklist
Describe the contribution
I've left the commits separated for now to make life easier for whoever reviews this. I can squash them if/when this is ready for merge.
Testing performed
None (comment and whitespace changes only).
Expected behavior changes
No impact on behavior.
These updates will reduce clutter and inconsistency in the code, improving readability.
Contributor Info
@thnkslprpt