capi: Add a note about error code and returned value relation #784
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
gumb0
commented
Apr 12, 2021
include/fizzy/fizzy.h
Outdated
| @@ -250,6 +255,9 @@ typedef struct FizzyImportedGlobal | |||
| /// @param error Pointer to store detailed error information at. Can be NULL if error | |||
| /// 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
approved these changes
Apr 16, 2021
chfast
approved these changes
Apr 16, 2021
axic
reviewed
Apr 16, 2021
include/fizzy/fizzy.h
Outdated
| @@ -260,6 +268,9 @@ bool fizzy_validate( | |||
| /// @param error Pointer to store detailed error information at. Can be NULL if error | |||
| /// information is not required. | |||
| /// @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.
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.
Addresses comment #769 (comment)