Change is_decodable/1 to decodable?/1
#138
Merged
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
azeemchauhan
changed the title
s_decodable/1 to decodable?/1
azeemchauhan
changed the title
s_decodable/1 to decodable?/1is_decodable/1 to decodable?/1
Strech
requested changes
Jan 24, 2025
There was a problem hiding this comment.
Thanks for your support @azeemchauhan I appreciate it!
I would like to make few adjustments to reduce the risk of mistake.
lib/avrora/codec.ex
Outdated
Comment on lines
20
to
25
| @doc """ | ||
| Checks whether a given binary Avro message is decodable with the Plain codec. | ||
|
|
||
| This function is deprecated and will be removed in future release. | ||
| Please use `Avrora.Codec.Plain.decodable?/1` instead. | ||
| """ |
There was a problem hiding this comment.
Could you delete the documentation @doc false and use @deprecated "Use ... instead"
| Logger.warning( | ||
| "`Avrora.Codec.ObjectContainerFile.is_decodable/1` is deprecated, use `Avrora.Codec.ObjectContainerFile.decodable?/1` instead" | ||
| ) | ||
|
|
||
| case payload do |
There was a problem hiding this comment.
Could you please replace the code with a call of decodable? instead of duplication
lib/avrora/codec/plain.ex
Outdated
| def is_decodable(payload) when is_binary(payload) do | ||
| Logger.warning("`Avrora.Codec.Plain.is_decodable/1` is deprecated, use `Avrora.Codec.Plain.decodable?/1` instead") | ||
|
|
||
| true |
There was a problem hiding this comment.
Could you please re-use new function instead?
azeemchauhan
commented
Jan 24, 2025
| false | ||
| """ | ||
| @callback decodable?(payload :: binary()) :: boolean | ||
|
|
||
| @doc deprecated: "Use `Avrora.Codec.Plain.decodable?/1` instead." |
There was a problem hiding this comment.
@callback can deprecated using soft-deprecation: e.g
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.
Addressing #132
Summary
is_decodable/1is used.