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. #3

Closed
2 tasks done
thnkslprpt opened this issue Oct 10, 2022 · 0 comments · Fixed by #4
Closed
2 tasks done

Comments

@thnkslprpt
Copy link
Contributor

thnkslprpt commented Oct 10, 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
  • #endif /* BP_IO_H */-type comments
  • function header comments which include the function name

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

Reporter Info
@thnkslprpt

jphickey added a commit that referenced this issue Oct 12, 2022
…eanup

Fix #3, Scrub for C++-style comments and redundant comments
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 a pull request may close this issue.

2 participants
@thnkslprpt and others