Skip to content

Fix #171, Remove function names from function header comments and clean up empty lines.#172

Open
thnkslprpt wants to merge 3 commits intonasa:mainfrom
thnkslprpt:fix-171-comment-and-empty-line-cleanup
Open

Fix #171, Remove function names from function header comments and clean up empty lines.#172
thnkslprpt wants to merge 3 commits intonasa:mainfrom
thnkslprpt:fix-171-comment-and-empty-line-cleanup

Conversation

@thnkslprpt
Copy link
Contributor

@thnkslprpt thnkslprpt commented Oct 14, 2022

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

Copy link
Collaborator

@jphickey jphickey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@thnkslprpt thnkslprpt force-pushed the fix-171-comment-and-empty-line-cleanup branch 3 times, most recently from a8dc24b to 7fe6513 Compare October 21, 2022 21:17
@thnkslprpt thnkslprpt requested a review from jphickey October 21, 2022 21:17
@thnkslprpt
Copy link
Contributor Author

I totally agree they make it easier to identify each function when scrolling through - added the empty ones back now.

@thnkslprpt thnkslprpt force-pushed the fix-171-comment-and-empty-line-cleanup branch from 7fe6513 to ba94e8c Compare March 14, 2023 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Redundant comments (/* end of function */, /* end if */ etc.) and clean up empty lines.

2 participants