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.

Sign up for GitHub

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

Jump to bottom

Redundant comments (/* end of function */, /* end if */ etc.) #88

Closed
2 tasks done
thnkslprpt opened this issue Oct 5, 2022 · 0 comments · Fixed by #89 or #90
Closed
2 tasks done

Redundant comments (/* end of function */, /* end if */ etc.) #88

thnkslprpt opened this issue Oct 5, 2022 · 0 comments · Fixed by #89 or #90

Comments

@thnkslprpt
Copy link
Contributor

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

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/sample_lib that referenced this issue Oct 5, 2022
@thnkslprpt
Fix nasa#88, Remove redundant comments
5ee283c
@thnkslprpt thnkslprpt mentioned this issue Oct 5, 2022
Merged
2 tasks
dzbaker added a commit that referenced this issue Oct 11, 2022
@dzbaker
Merge pull request #89 from thnkslprpt/fix-88-comment-cleanup
9526649 
Fix #88, Remove redundant comments
@dzbaker dzbaker mentioned this issue Oct 11, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
1 participant
@thnkslprpt