Fix #2162, Remove redundant/inconsistent comments (/* end of function */, /* end if */ etc.) and clean up empty lines. #2163
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@thnkslprpt CCB 6 October 2022: Approved pending workflow failure resolution. |
thnkslprpt
force-pushed
the
fix-2162-comment-cleanup
branch
from
6f1e234
to
b7bf34c
Compare
dzbaker
added
the
CCB:Approved
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 <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> Co-authored by: Sam Price <thesamprice@users.noreply.github.com>
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 <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> Co-authored by: Sam Price <thesamprice@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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