1
Fork 0

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?~~
This commit is contained in:
Yuki Okushi 2020-08-08 11:36:03 +09:00 committed by GitHub
commit 255434d83c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 78 additions and 18 deletions

View file

@ -1395,10 +1395,13 @@ impl Clean<Type> for hir::Ty<'_> {
_ => None, _ => None,
}); });
if let Some(lt) = lifetime.cloned() { if let Some(lt) = lifetime.cloned() {
if !lt.is_elided() { let lt_def_id = cx.tcx.hir().local_def_id(param.hir_id);
let lt_def_id = cx.tcx.hir().local_def_id(param.hir_id); let cleaned = if !lt.is_elided() {
lt_substs.insert(lt_def_id.to_def_id(), lt.clean(cx)); lt.clean(cx)
} } else {
self::types::Lifetime::elided()
};
lt_substs.insert(lt_def_id.to_def_id(), cleaned);
} }
indices.lifetimes += 1; indices.lifetimes += 1;
} }
@ -1957,21 +1960,17 @@ impl Clean<GenericArgs> for hir::GenericArgs<'_> {
output: if output != Type::Tuple(Vec::new()) { Some(output) } else { None }, output: if output != Type::Tuple(Vec::new()) { Some(output) } else { None },
} }
} else { } else {
let elide_lifetimes = self.args.iter().all(|arg| match arg {
hir::GenericArg::Lifetime(lt) => lt.is_elided(),
_ => true,
});
GenericArgs::AngleBracketed { GenericArgs::AngleBracketed {
args: self args: self
.args .args
.iter() .iter()
.filter_map(|arg| match arg { .map(|arg| match arg {
hir::GenericArg::Lifetime(lt) if !elide_lifetimes => { hir::GenericArg::Lifetime(lt) if !lt.is_elided() => {
Some(GenericArg::Lifetime(lt.clean(cx))) GenericArg::Lifetime(lt.clean(cx))
} }
hir::GenericArg::Lifetime(_) => None, hir::GenericArg::Lifetime(_) => GenericArg::Lifetime(Lifetime::elided()),
hir::GenericArg::Type(ty) => Some(GenericArg::Type(ty.clean(cx))), hir::GenericArg::Type(ty) => GenericArg::Type(ty.clean(cx)),
hir::GenericArg::Const(ct) => Some(GenericArg::Const(ct.clean(cx))), hir::GenericArg::Const(ct) => GenericArg::Const(ct.clean(cx)),
}) })
.collect(), .collect(),
bindings: self.bindings.clean(cx), bindings: self.bindings.clean(cx),

View file

@ -750,6 +750,10 @@ impl Lifetime {
pub fn statik() -> Lifetime { pub fn statik() -> Lifetime {
Lifetime("'static".to_string()) Lifetime("'static".to_string())
} }
pub fn elided() -> Lifetime {
Lifetime("'_".to_string())
}
} }
#[derive(Clone, Debug)] #[derive(Clone, Debug)]

View file

@ -2,9 +2,9 @@ use crate::clean::auto_trait::AutoTraitFinder;
use crate::clean::blanket_impl::BlanketImplFinder; use crate::clean::blanket_impl::BlanketImplFinder;
use crate::clean::{ use crate::clean::{
inline, Clean, Crate, Deprecation, ExternalCrate, FnDecl, FnRetTy, Generic, GenericArg, inline, Clean, Crate, Deprecation, ExternalCrate, FnDecl, FnRetTy, Generic, GenericArg,
GenericArgs, GenericBound, Generics, GetDefId, ImportSource, Item, ItemEnum, MacroKind, Path, GenericArgs, GenericBound, Generics, GetDefId, ImportSource, Item, ItemEnum, Lifetime,
PathSegment, Primitive, PrimitiveType, ResolvedPath, Span, Stability, Type, TypeBinding, MacroKind, Path, PathSegment, Primitive, PrimitiveType, ResolvedPath, Span, Stability, Type,
TypeKind, Visibility, WherePredicate, TypeBinding, TypeKind, Visibility, WherePredicate,
}; };
use crate::core::DocContext; use crate::core::DocContext;
@ -121,7 +121,10 @@ pub fn external_generic_args(
let args: Vec<_> = substs let args: Vec<_> = substs
.iter() .iter()
.filter_map(|kind| match kind.unpack() { .filter_map(|kind| match kind.unpack() {
GenericArgKind::Lifetime(lt) => lt.clean(cx).map(GenericArg::Lifetime), GenericArgKind::Lifetime(lt) => match lt {
ty::ReLateBound(_, ty::BrAnon(_)) => Some(GenericArg::Lifetime(Lifetime::elided())),
_ => lt.clean(cx).map(GenericArg::Lifetime),
},
GenericArgKind::Type(_) if skip_self => { GenericArgKind::Type(_) if skip_self => {
skip_self = false; skip_self = false;
None None

View file

@ -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)
}

View file

@ -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>&lt;'_&gt;"
pub fn test1(a: &u32) -> Ref {
Ref(a)
}
// @has foo/fn.test2.html
// @matches - "Ref</a>&lt;'_&gt;"
pub fn test2(a: &u32) -> Ref<'_> {
Ref(a)
}
// @has foo/fn.test3.html
// @matches - "Ref</a>&lt;'_&gt;"
pub fn test3(a: &u32) -> ARef {
Ref(a)
}
// @has foo/fn.test4.html
// @matches - "Ref</a>&lt;'_&gt;"
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>&lt;'_&gt;"
// @has foo/bar/fn.test6.html
// @matches - "Ref</a>&lt;'_&gt;"
#[doc(inline)]
pub extern crate bar;