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

Fix #367, Remove redundant/inconsistent comments (/* end of function */, /* end if */ etc.) and clean up empty lines. #368

Merged

Conversation

thnkslprpt
Copy link
Contributor

Checklist

Describe the contribution
Fixes #367
Removes redundant and inconsistent comments (e.g. /* end of function */, /* end if */, function name in function header comments).
There were also a few cases of unnecessary empty lines (e.g. on the last line before the closing brace of a function) and also missing empty lines (e.g. between functions) which were corrected. Some of these empty lines trigger the CI format checks.
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

@dzbaker
Copy link
Contributor

dzbaker commented Oct 13, 2022

@thnkslprpt CCB 13 October 2022: Approved pending squash of commits and ensuring that commit message follows format and internal review of changes.

@thnkslprpt thnkslprpt force-pushed the fix-367-comment-and-empty-line-cleanup branch from e5a4c9f to 65f8e10 Compare October 13, 2022 20:30
@thnkslprpt
Copy link
Contributor Author

@thnkslprpt CCB 13 October 2022: Approved pending squash of commits and ensuring that commit message follows format and internal review of changes.

Squashed together now mate.

dzbaker added a commit to nasa/cFS that referenced this pull request Oct 17, 2022
*Combines:*

cfe v7.0.0-rc4+dev197
osal v7.0.0-rc4+dev143
psp v1.6.0-rc4+dev61
elf2cfetbl v3.4.0-rc4+dev30
sch_lab v2.5.0-rc4+dev45

**Includes:**

*cFS*
- #589

*cFE*
- nasa/cFE#2165

*osal*
- nasa/osal#1311
- nasa/osal#1310
- nasa/osal#1313
- nasa/osal#1306
- nasa/osal#1309

*psp*
- nasa/PSP#365
- nasa/PSP#368

*sch_lab*
- nasa/sch_lab#126

*elf2cfetbl*
- nasa/elf2cfetbl#119

Co-authored-by: Avi Weiss <thnkslprpt@users.noreply.github.com>
Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored by: Ariel Adams <arielsadamsnasa@users.noreply.github.com>
@dzbaker dzbaker mentioned this pull request Oct 17, 2022
2 tasks
@dzbaker dzbaker merged commit f75167e into nasa:main Oct 17, 2022
dzbaker added a commit to nasa/cFS that referenced this pull request Oct 17, 2022
*Combines:*

cfe v7.0.0-rc4+dev197
osal v7.0.0-rc4+dev143
psp v1.6.0-rc4+dev61
elf2cfetbl v3.4.0-rc4+dev30
sch_lab v2.5.0-rc4+dev45

**Includes:**

*cFS*
- #589

*cFE*
- nasa/cFE#2165

*osal*
- nasa/osal#1311
- nasa/osal#1310
- nasa/osal#1313
- nasa/osal#1306
- nasa/osal#1309

*psp*
- nasa/PSP#365
- nasa/PSP#368

*sch_lab*
- nasa/sch_lab#126

*elf2cfetbl*
- nasa/elf2cfetbl#119

Co-authored-by: Avi Weiss <thnkslprpt@users.noreply.github.com>
Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored by: Ariel Adams <arielsadamsnasa@users.noreply.github.com>
@thnkslprpt thnkslprpt deleted the fix-367-comment-and-empty-line-cleanup branch October 17, 2022 20:48
@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
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.
4 participants