Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to highlight differences between DefaultOptions and fns #373

Merged
merged 1 commit into from
Feb 23, 2021

Conversation

apgoetz
Copy link
Contributor

@apgoetz apgoetz commented Feb 22, 2021

Due to historical reasons, the default options used by bincode for the helper functions at the root of the crate differ from the options in the config module.

Changing the default options is a breaking change, so until a decision is made, we can at least document the current behavior.

Related issue: #348

…ions

Due to historical reasons, the default options used by bincode for the
helper functions at the root of the crate differ from the options in
the `config` module.

Changing the default options is a breaking change, so until a decision
is made, we can at least document the current behavior.
@ZoeyR
Copy link
Collaborator

ZoeyR commented Feb 23, 2021

Looks great! thanks.

@ZoeyR ZoeyR merged commit fdf9358 into bincode-org:master Feb 23, 2021
@apgoetz apgoetz deleted the update-option-docs branch February 28, 2021 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation says varint is the default, but it isn't unless you use Options
2 participants