Trailing whitespaces are stripped in raw string literals in doc tests
Open
Nobody has claimed this yet.
A-comments
P-low
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
Example:
/// Doc Test
/// ```rust
/// let expected = "\nfoo \n";
/// assert_eq!(expected, r#"
/// foo
/// "#);
/// ```
pub fn main() {}
Note that the expected string has a space before the last newline.
cargo fmt strips the space in the raw string literal, causing passing doc tests to fail afterwards
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the example with cargo fmt and the Rust doc test shown in the issue, then trace rustfmt's handling of raw string literals in doc tests. Done means the space before the final newline is preserved by formatting and the doc test continues to pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100