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

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

Closed
2 tasks done
thnkslprpt opened this issue Oct 9, 2022 · 0 comments · Fixed by #35
Closed
2 tasks done
Milestone

Comments

@thnkslprpt
Copy link
Contributor

thnkslprpt commented Oct 9, 2022

Checklist

  • I reviewed the Contributing Guide.
  • I performed a cursory search to see if the bug report is relevant, not redundant, nor in conflict with other tickets.

Describe the bug
Copy of nasa/to_lab#68 and nasa/sample_app#111
There are quite a few redundant comments in the code, such as:

  • /* end of function */-type comments
  • /* end if */-type comments
  • function header comments which include the function name

Another minor issue has to do with empty lines:
a) unnecessary empty lines (e.g. first line after the opening brace of a function/struct, or the last line before the closing brace - the latter apparently sometimes triggers the CI format checks).
b) missing empty lines between functions (i.e. closing brace of last function, then next function beginning on the immediately next line without an empty line in between)

The unnecessary empty lines (at the beginning or end of a function, for example) represent a low single-digit percentage of the cases (the vast majority of functions/structs do not have these extra empty lines), so there is an argument to remove them purely for consistency, not just due to them being redundant and triggering the CI format checks.

Expected behavior
Remove redundant comments to reduce clutter and inconsistency in the code, and improve readability.

Reporter Info
@thnkslprpt

thnkslprpt added a commit to thnkslprpt/MD that referenced this issue Oct 9, 2022
thnkslprpt added a commit to thnkslprpt/MD that referenced this issue Oct 13, 2022
dzbaker added a commit that referenced this issue Oct 14, 2022
…cleanup

Fix #34, Remove redundant/inconsistent comments (/* end of function */, /* end if */ etc.) and clean up empty lines.
@dmknutsen dmknutsen added this to the Draco milestone Jan 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants