-
Notifications
You must be signed in to change notification settings - Fork 46
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
Function names differing only by trailing underscore #110
Comments
This was originally noted in #42 but split to a separate work item |
After PR #137 (which fixes a few) the following name issues remain: CF_CFDP_CycleTx_ |
jphickey
added a commit
to jphickey/CF
that referenced
this issue
Jan 6, 2022
jphickey
added a commit
to jphickey/CF
that referenced
this issue
Jan 6, 2022
jphickey
added a commit
to jphickey/CF
that referenced
this issue
Jan 11, 2022
jphickey
added a commit
to jphickey/CF
that referenced
this issue
Jan 11, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
CF has a number of cases where function names differ only in a trailing underscore(s), which is likely to violate some coding standards because they look too similar and can be easily confused. An example offender is
CF_CFDP_TxFile()
,CF_CFDP_TxFile_()
, andCF_CFDP_TxFile__()
.These internal helpers with only trailing underscores should be renamed to something more descriptive to make it clear what the intent of the function really is (e.g. in the example, the double-underscore version seems to be simply a wrapper to initialize the transaction structure ... seems to have nothing to do with sending files at all, really - just a generic initialization helper).
The text was updated successfully, but these errors were encountered: