diff options
| author | Yuki Okushi <huyuumi.dev@gmail.com> | 2020-08-08 11:36:03 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-08 11:36:03 +0900 |
| commit | 255434d83cab2dab5ab5c7d942a5dbfcda3db894 (patch) | |
| tree | 4c5e58c791bbd52482f65f5733e168ec396e6d2d /src/test/rustdoc | |
| parent | f5d2ffd7fb94807555cc370eb0ec01822f04abe3 (diff) | |
| parent | 541fbbb6fab4afdeea48fdb9e94cee48991b3333 (diff) | |
| download | rust-255434d83cab2dab5ab5c7d942a5dbfcda3db894.tar.gz rust-255434d83cab2dab5ab5c7d942a5dbfcda3db894.zip | |
Rollup merge of #75237 - nbdd0121:rustdoc, r=jyn514
Display elided lifetime for non-reference type in doc In edition 2018 we encourage writing `<'_>` explicitly, so rustdoc should display like such as well. Fixes #75225 ~~Somehow when I run the compiled rustdoc using `cargo +stage2 doc` on other crates, it correctly produces `<'_>`, but I couldn't get the std doc to do the same with `./x.py doc --stage 2`. Might this be related to the recent change to x.py about how the doc is built?~~
Diffstat (limited to 'src/test/rustdoc')
| -rw-r--r-- | src/test/rustdoc/auxiliary/elided-lifetime.rs | 11 | ||||
| -rw-r--r-- | src/test/rustdoc/elided-lifetime.rs | 43 |
2 files changed, 54 insertions, 0 deletions
diff --git a/src/test/rustdoc/auxiliary/elided-lifetime.rs b/src/test/rustdoc/auxiliary/elided-lifetime.rs new file mode 100644 index 00000000000..4f2c93379d8 --- /dev/null +++ b/src/test/rustdoc/auxiliary/elided-lifetime.rs @@ -0,0 +1,11 @@ +#![crate_name = "bar"] + +pub struct Ref<'a>(&'a u32); + +pub fn test5(a: &u32) -> Ref { + Ref(a) +} + +pub fn test6(a: &u32) -> Ref<'_> { + Ref(a) +} diff --git a/src/test/rustdoc/elided-lifetime.rs b/src/test/rustdoc/elided-lifetime.rs new file mode 100644 index 00000000000..5a32554f972 --- /dev/null +++ b/src/test/rustdoc/elided-lifetime.rs @@ -0,0 +1,43 @@ +// aux-build:elided-lifetime.rs +// +// rust-lang/rust#75225 +// +// Since Rust 2018 we encourage writing out <'_> explicitly to make it clear +// that borrowing is occuring. Make sure rustdoc is following the same idiom. + +#![crate_name = "foo"] + +pub struct Ref<'a>(&'a u32); +type ARef<'a> = Ref<'a>; + +// @has foo/fn.test1.html +// @matches - "Ref</a><'_>" +pub fn test1(a: &u32) -> Ref { + Ref(a) +} + +// @has foo/fn.test2.html +// @matches - "Ref</a><'_>" +pub fn test2(a: &u32) -> Ref<'_> { + Ref(a) +} + +// @has foo/fn.test3.html +// @matches - "Ref</a><'_>" +pub fn test3(a: &u32) -> ARef { + Ref(a) +} + +// @has foo/fn.test4.html +// @matches - "Ref</a><'_>" +pub fn test4(a: &u32) -> ARef<'_> { + Ref(a) +} + +// Ensure external paths in inlined docs also display elided lifetime +// @has foo/bar/fn.test5.html +// @matches - "Ref</a><'_>" +// @has foo/bar/fn.test6.html +// @matches - "Ref</a><'_>" +#[doc(inline)] +pub extern crate bar; |
