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 #2162, Remove redundant/inconsistent comments (/* end of function */, /* end if */ etc.) and clean up empty lines. #2163

Merged
merged 1 commit into from
Oct 11, 2022

Conversation

thnkslprpt
Copy link
Contributor

@thnkslprpt thnkslprpt commented Oct 6, 2022

Checklist

Describe the contribution
Fixes #2162
Removes redundant and inconsistent comments (incl. /* 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
Collaborator

dzbaker commented Oct 6, 2022

@thnkslprpt CCB 6 October 2022: Approved pending workflow failure resolution.

@dzbaker dzbaker added the CCB:Approved Indicates code review and approval by community CCB label Oct 11, 2022
dzbaker added a commit to nasa/cFS that referenced this pull request Oct 11, 2022
*Combines:*

cfe v7.0.0-rc4+dev193
cFS-GroundSystem v3.0.0-rc4+dev33
osal v7.0.0-rc4+dev131
to_lab v2.5.0-rc4+dev31
ci_lab v2.5.0-rc4+dev39
sample_app v1.3.0-rc4+dev35
sample_lib v1.3.0-rc4+dev28
tblCRCTool v1.3.0-rc4+dev24
elf2cfetbl v3.4.0-rc4+dev26
sch_lab v2.5.0-rc4+dev41

**Includes:**

*cFS*
- #567
- #514

*cFE*
- nasa/cFE#2163
- nasa/cFE#2158
- nasa/cFE#2159

*osal*
- nasa/osal#1283
- nasa/osal#1291
- nasa/osal#1298

*sample_app*
- nasa/sample_app#185
- nasa/sample_app#183

*sch_lab*
- nasa/sch_lab#123

*tblCRCTool*
- nasa/tblCRCTool#73

*to_lab*
- nasa/to_lab#127
- nasa/to_lab#126
- nasa/to_lab#129

*ci_lab*
- nasa/ci_lab#123
- nasa/ci_lab#120

*sample_lib*
- nasa/sample_lib#89
- nasa/sample_lib#86

*cFS-GroundSystem*
- nasa/cFS-GroundSystem#224
- nasa/cFS-GroundSystem#225

*elf2cfetbl*
- nasa/elf2cfetbl#117

Co-authored-by: Avi Weiss <[email protected]>
Co-authored by: Joseph Hickey <[email protected]>
Co-authored by: Ariel Adams <[email protected]>
Co-authored by: Sam Price <[email protected]>
@dzbaker dzbaker mentioned this pull request Oct 11, 2022
2 tasks
@dzbaker dzbaker merged commit 6b85824 into nasa:main Oct 11, 2022
dzbaker added a commit to nasa/cFS that referenced this pull request Oct 11, 2022
*Combines:*

cfe v7.0.0-rc4+dev193
cFS-GroundSystem v3.0.0-rc4+dev33
osal v7.0.0-rc4+dev131
to_lab v2.5.0-rc4+dev31
ci_lab v2.5.0-rc4+dev39
sample_app v1.3.0-rc4+dev35
sample_lib v1.3.0-rc4+dev28
tblCRCTool v1.3.0-rc4+dev24
elf2cfetbl v3.4.0-rc4+dev26
sch_lab v2.5.0-rc4+dev41

**Includes:**

*cFS*
- #567
- #514

*cFE*
- nasa/cFE#2163
- nasa/cFE#2158
- nasa/cFE#2159

*osal*
- nasa/osal#1283
- nasa/osal#1291
- nasa/osal#1298

*sample_app*
- nasa/sample_app#185
- nasa/sample_app#183

*sch_lab*
- nasa/sch_lab#123

*tblCRCTool*
- nasa/tblCRCTool#73

*to_lab*
- nasa/to_lab#127
- nasa/to_lab#126
- nasa/to_lab#129

*ci_lab*
- nasa/ci_lab#123
- nasa/ci_lab#120

*sample_lib*
- nasa/sample_lib#89
- nasa/sample_lib#86

*cFS-GroundSystem*
- nasa/cFS-GroundSystem#224
- nasa/cFS-GroundSystem#225

*elf2cfetbl*
- nasa/elf2cfetbl#117

Co-authored-by: Avi Weiss <[email protected]>
Co-authored by: Joseph Hickey <[email protected]>
Co-authored by: Ariel Adams <[email protected]>
Co-authored by: Sam Price <[email protected]>
@thnkslprpt thnkslprpt deleted the fix-2162-comment-cleanup branch October 11, 2022 21:34
@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
CCB:Approved Indicates code review and approval by community CCB draco-rc4
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.
3 participants