Conversation
jphickey
left a comment
jphickey
left a comment
There was a problem hiding this comment.
I concur with the general desire to make the names of the parameters consistent between the declaration and definition, but in this case the names in the headers (API) are probably the preferred names for these values. For example, in the "timebase" module, the IDs should all be "timebase_id" rather than "timer_id" (the latter probably a remnant of cut-and-paste from the timer API). Somewhere along the way, the headers got updated appropriately, but the implementation wasn't. We should just update the implementation, not revert the header.
As a side note, cppcheck should be finding and reporting differences in these parameter names, but does not seem to be flagging these items. This might point to a problem with our cppcheck workflow not covering everything it is supposed to.
thnkslprpt
force-pushed
the
fix-1353-mismatched-function-parameter-names
branch
from
c0c8b3c to
5f664fe
Compare
thnkslprpt
force-pushed
the
fix-1353-mismatched-function-parameter-names
branch
from
5f664fe to
a92b2b7
Compare
jphickey
added
the
CCB:Ready
dzbaker
added
CCB:Approved
*Combines:* cFE equuleus-rc1+dev96 osal equuleus-rc1+dev53 to_lab equuleus-rc1+dev44 **Includes:** *cFE* - nasa/cFE#2515 - nasa/cFE#2330 *osal* - nasa/osal#1448 - nasa/osal#1146 - nasa/osal#1357 - nasa/osal#1354 - nasa/osal#1331 *to_lab* - nasa/to_lab#191 - nasa/to_lab#136 Co-authored by: Joseph Hickey <[email protected]> Co-authored by: Avi Weiss <[email protected]> Co-authored by: Sam Price <[email protected]>
*Combines:* cFE equuleus-rc1+dev96 osal equuleus-rc1+dev53 to_lab equuleus-rc1+dev44 **Includes:** *cFE* - nasa/cFE#2515 - nasa/cFE#2330 *osal* - nasa/osal#1448 - nasa/osal#1146 - nasa/osal#1357 - nasa/osal#1354 - nasa/osal#1331 *to_lab* - nasa/to_lab#191 - nasa/to_lab#136 Co-authored by: Joseph Hickey <[email protected]> Co-authored by: Avi Weiss <[email protected]> Co-authored by: Sam Price <[email protected]>
3 participants
Checklist
Describe the contribution
May as well clean these up now to avoid any potential future compiler warnings and ease maintainability/readability.
Note: one of these cases was noticed in #185, but closed as 'won't fix' at the time.
Testing performed
GitHub CI actions (incl. Build + Run, Unit Tests etc.) all passing successfully.
Expected behavior changes
Function prototypes and their implementations should (ideally) always have matching parameter names.
Contributor Info
Avi Weiss @thnkslprpt