Conversation
Further down in the header the function `json_error_code()` is defined to return the `enum json_error_code`. That function has a much better documentation value, as it also defines what values the returned value can have. It also sets a naming precedent, of having a function of the same name as the enum, which makes a lot of sense to me. In the future, when you bump the major version of the library anyway, you could change the define of json_typeof to `#define json_typeof json_type` and maybe start a deprecation cycle of the old name.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Further down in the header the function
json_error_code()is defined to return theenum json_error_code.That function has a much better documentation value, as it also defines what values the returned value can have.
It also sets a naming precedent, of having a function of the same name as the enum, which makes a lot of sense to me.
In the future, when you bump the major version of the library anyway, you could change the define of json_typeof to
#define json_typeof json_typeand maybe start a deprecation cycle of the old name.
What do you think? Would that be a good patch?