Adapt cppcodec usage to current recommendations #289
Merged
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.
Hi there, cppcodec maintainer here. Thanks for using my library!
I released the 0.2 version a few months ago, which include a note that
*_default_*.hpp
includes are not recommended anymore and may be discontinued in the future. Not sure how popular your software is, but if you're going through the trouble of writing tutorials of your own, I think maybe I should try to update your examples, so people adopt the "right" way of doing things after looking at your README.The good news is that you've already been using your own alias statements, like here:
The types on the right hand are provided by the header files of the same name, no
*_default_*
ones are required and the only change I'd make is adapting the actual include lines.(I also took out the hex include from your README because you didn't use it in the example code. Let me know if this is wrong.)
Here's a patch to do this. The patch is trivial enough that I don't believe any of my copyright applies to it. (You look like you may be a commercial entity, so let's just get this out of the way.) I haven't built your software, but I'm pretty confident that it should continue working.
Cheers, and good luck with your project!