Revert: Remove the book.multilingual field and don't serialize it #2689
Conversation
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
This reverts rust-lang#2646 because I overlooked that this is a public field in a public struct, which would be a breaking API change.
This skips serializing of the multilingual field since it is unused, and we plan to remove it in the future. This helps avoid it showing up in `mdbook init`.
|
Why is this a breaking API change and how could one (well, me) know? |
|
Removing a field from a public type is a breaking change because code that constructs the type, such as: BookConfig {
title: Some(String::from("mdBook Documentation")),
authors: vec![],
description: Some(String::from("Description")),
src: PathBuf::from("./source"),
multilingual: false,
language: None,
text_direction: None,
};This would fail to compile if the field was removed. This can be checked with something like |
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.
This reverts #2646 since I overlooked that this would be a breaking API change. Instead it just adds a
serde(skip_serializing)so that it doesn't show up inmdbook init. We'll plan to remove it in the future (cc #2636).