capi: Add a note about error code and returned value relation#784
capi: Add a note about error code and returned value relation#784
Conversation
include/fizzy/fizzy.h
Outdated
| /// information is not required. | ||
| /// @return true if module is valid, false otherwise. | ||
| /// | ||
| /// @note FizzyError::code must be ::FizzySuccess if function returns `true` and must not be |
There was a problem hiding this comment.
Does this not sound like it's a requirement to a user's input?
There was a problem hiding this comment.
Yeah I think so. Would suggest something like "FizzyError::code will be ::FizzySuccess if functions...".
Codecov Report
@@ Coverage Diff @@
## master #784 +/- ##
==========================================
- Coverage 99.24% 99.24% -0.01%
==========================================
Files 79 79
Lines 11964 11962 -2
==========================================
- Hits 11874 11872 -2
Misses 90 90
Flags with carried forward coverage won't be shown. Click here to find out more.
|
axic
left a comment
axic
left a comment
There was a problem hiding this comment.
Still suggest to use "will be" instead of "must be".
include/fizzy/fizzy.h
Outdated
| /// @return non-NULL pointer to module in case of success, NULL otherwise. | ||
| /// | ||
| /// @note FizzyError::code will be ::FizzySuccess if function returns non-NULL | ||
| /// will and must not be ::FizzySuccess otherwise. |
There was a problem hiding this comment.
Nit: the other places used will not be.
3 participants
Addresses comment #769 (comment)