This repository was archived by the owner on Aug 15, 2025. It is now read-only.
Put clarifying language in migration guide regarding the serde:: and non-serde:: paths#715
Merged
VictorKoenders merged 2 commits intobincode-org:trunkfrom Aug 7, 2024
Merged
Conversation
VictorKoenders
suggested changes
May 28, 2024
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Contributor
Author
|
Nothing has changed, so this problem is still real. I still think this patch should be merged. |
Contributor
|
Please fix the change I've requested and we can get this merged |
Contributor
Author
|
Sorry, I misunderstood your comment before. Is that better? |
Contributor
|
Thanks! |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
This past week I ported a crate from bincode1 to bincode2. I had some difficulty because I took the "migrate serde to bincode-derive" path, which was not appropriate for my application. I was following the migration guide, but I misread it.
I would like to recommend some minor language tweaks to make the migration guide more resistant to misinterpretation. Proposed language is attached, but I don't care if you use my specific language. I do suggest you make some form of the following changes:
serde" and "Migrating tobincode-derive" sections describe exclusive options.This would have helped me do my porting correctly the first time.