Skip to content

What to do with the book.multilingual field? #2636

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.

Sign up for GitHub

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

Jump to bottom
Open
szabgab opened this issue Apr 3, 2025 · 2 comments · Fixed by #2646
Open

What to do with the book.multilingual field? #2636

szabgab opened this issue Apr 3, 2025 · 2 comments · Fixed by #2646
Labels
C-question Category: A question on how to do something
Milestone
0.5

Comments

@szabgab
Copy link
Contributor

szabgab commented Apr 3, 2025 •
edited
Loading

Question

The code here

mdBook/src/config.rs

Line 424 in 4f698f8

pub multilingual: bool,

expects a field called multilingual in the [book] section of book.toml.

The mdbook init command even ads it to the book.toml file.

However, this field does not seem to be used anywhere in the code and it is not mentioned in the documentation either.

Shall we remove it from the code and start warning about its presence?
@szabgab szabgab added the C-question Category: A question on how to do something label Apr 3, 2025
szabgab added a commit to szabgab/mdBook that referenced this issue Apr 3, 2025
@szabgab
Warn on invalid fields in the [book] section of book.toml
7c87a81 
A step for rust-lang#1595.

We might need to revise this if de decide to remove the `multilingual`
field as described in rust-lang#2636
@szabgab szabgab mentioned this issue Apr 3, 2025
Open
@ehuss
Copy link
Contributor

ehuss commented Apr 4, 2025

Yea, I have no idea what that field is for, and it doesn't look like it was ever used. I'd be fine removing it.

szabgab added a commit to szabgab/mdBook that referenced this issue Apr 6, 2025
@szabgab
Remove the book.multilingual field
ee59e22 
As it is seems it has never been in real use.

See rust-lang#2636
@szabgab szabgab mentioned this issue Apr 6, 2025
Merged
@szabgab szabgab mentioned this issue Apr 9, 2025
Open
szabgab added a commit to szabgab/mdBook that referenced this issue Apr 9, 2025
@szabgab
Warn on invalid fields in the [book] section of book.toml
c153451 
A step for rust-lang#1595.

We might need to revise this if de decide to remove the `multilingual`
field as described in rust-lang#2636
@ehuss ehuss mentioned this issue May 5, 2025
Merged
@ehuss
Copy link
Contributor

ehuss commented May 5, 2025

Reopening since I overlooked that this would be a breaking API change.
#2689

@ehuss ehuss reopened this May 5, 2025
@ehuss ehuss added this to the 0.5 milestone May 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-question Category: A question on how to do something
Projects
None yet
Milestone
0.5
Development

Successfully merging a pull request may close this issue.

Remove the book.multilingual field szabgab/mdBook
2 participants
@ehuss @szabgab