Skip to content

Synchronize TrplNote name - #4605

Merged
carols10cents merged 1 commit into
rust-lang:mainfrom
ehuss:trpl-note-name
Dec 12, 2025
Merged

carols10cents merged 1 commit into
rust-lang:mainfrom
ehuss:trpl-note-name

Conversation

@ehuss

@ehuss ehuss commented Dec 12, 2025

Copy link
Copy Markdown
Contributor

This changes the name of the TrplNote mdbook preprocessor so that it matches the name used in book.toml. The reason this needs to be in sync is that in upstream we use MDBook::with_preprocessor to replace the preprocessor, but unfortunately it grabs the name from the preprocessor itself. If these are out of sync, it ends up not being able to replace the old preprocessor config. The API in mdbook should probably be better to make it easier to manage the config. For now, this is probably the easiest fix.

This changes the name of the `TrplNote` mdbook preprocessor so that it
matches the name used in `book.toml`. The reason this needs to be in
sync is that in upstream we use `MDBook::with_preprocessor` to replace
the preprocessor, but unfortunately it grabs the name from the
preprocessor itself. If these are out of sync, it ends up not being able
to replace the old preprocessor config. The API in mdbook should
probably be better to make it easier to manage the config. For now, this
is probably the easiest fix.

@carols10cents carols10cents left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine to me! Thank you!

@carols10cents
carols10cents merged commit 39aecea into rust-lang:main Dec 12, 2025
3 checks passed
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.

2 participants