Skip to content
This repository was archived by the owner on Aug 15, 2025. It is now read-only.

Update docs to highlight differences between DefaultOptions and fns#373

Merged
1 commit merged intobincode-org:masterfrom
apgoetz:update-option-docs
Feb 23, 2021
Merged

Update docs to highlight differences between DefaultOptions and fns#373
1 commit merged intobincode-org:masterfrom
apgoetz:update-option-docs

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.
@ghost ghost linked an issue Feb 23, 2021 that may be closed by this pull request
@ghost
Copy link

ghost commented Feb 23, 2021

Looks great! thanks.

@ghost ghost merged commit fdf9358 into bincode-org:master Feb 23, 2021
@apgoetz apgoetz deleted the update-option-docs branch February 28, 2021 21:51
This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

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

1 participant