fix(links): support spaces in #include file paths - #3163
Open
l46983284-cpu wants to merge 1 commit into
Open
Conversation
Parse the full include/rustdoc_include target instead of splitting on whitespace, so paths like `fila a.md` work. Line ranges still work (`fila a.md:1:2`). Playground links keep whitespace-separated properties. Fixes rust-lang#2812. Signed-off-by: Alex Chen <l46983284@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
{{#include}}and{{#rustdoc_include}}now use the full captured path instead of splitting on whitespace, so file names and paths may contain spaces (for example{{#include fila a.md}}). Line ranges still work ({{#include fila a.md:1:2}}).Playground links are unchanged and still use whitespace-separated path and properties.
Fixes #2812.
Test plan
links.rsfor paths with spaces (with and without line ranges)includes/all_includestestsuite casecargo test -p mdbook-driver --lib builtin_preprocessors::links::testscargo test -p mdbook --test testsuite includes::includecargo fmt --allandcargo clippy -p mdbook-driver --lib --no-deps -- -D warnings