Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-26 04:53:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

Correctly fix formatting doc tests with generics

Browse source 
Before the doc_test would be outputted like this:
"Foo<T, U>::t"
However, this would cause shells with shell redirection. I've changed it
so when generics are involved we simply wrap the expression under escape
chanters as so:
"\"Foo<T, U>::t\""

Note:
At the cost of adding this, I had to allocate a new string via
format!{}. However, I argue this is alright as this for just for
outputting the name of the doc test.

The following tests have been changed:
runnables::tests::doc_test_type_params
runnables::tests::test_doc_runnables_impl_mod
runnables::tests::test_runnables_doc_test_in_impl
This commit is contained in:
KarlWithK 2022-02-17 20:27:37 -06:00
parent 89faff7477
commit 5f3327a6b8
No known key found for this signature in database
GPG key ID: 183357B41320BB2B
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
crates/ide/src/runnables.rs
View file

@ -426,8 +426,8 @@ fn module_def_doctest(db: &RootDatabase, def: Definition) -> Option<Runnable> {
ty_args.format_with(", ", |ty, cb| cb(&ty.display(db))) ty_args.format_with(", ", |ty, cb| cb(&ty.display(db)))
); );
} }
format_to!(path, "::{}", def_name); format_to!(path, "::{}\"", def_name);
return Some(path); return Some(format!("\"{}", path));
} }
} }
} }
@ -966,7 +966,7 @@ impl Data {
}, },
kind: DocTest { kind: DocTest {
test_id: Path( test_id: Path(
"Data::foo", "\"Data::foo\"",
), ),
}, },
cfg: None, cfg: None,
@ -1360,7 +1360,7 @@ impl Foo {
}, },
kind: DocTest { kind: DocTest {
test_id: Path( test_id: Path(
"foo::Foo::foo", "\"foo::Foo::foo\"",
), ),
}, },
cfg: None, cfg: None,
@ -2066,7 +2066,7 @@ impl<T, U> Foo<T, U> {
}, },
kind: DocTest { kind: DocTest {
test_id: Path( test_id: Path(
"Foo<T, U>::t", "\"Foo<T, U>::t\"",
), ),
}, },
cfg: None, cfg: None,