diff options
| author | Mara Bos <m-ou.se@m-ou.se> | 2020-11-12 19:46:08 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-12 19:46:08 +0100 |
| commit | 4b0b42a2808e9d1f4f49bc9e3767f90feacbd152 (patch) | |
| tree | 9ca890cf1bd263bdfdb22bccab2d2dba15996b90 | |
| parent | 9722952f0bed5815cb22cb4878be09fb39f92804 (diff) | |
| parent | 38127caf730ab6e99d3ea546db4c2df69229afba (diff) | |
| download | rust-4b0b42a2808e9d1f4f49bc9e3767f90feacbd152.tar.gz rust-4b0b42a2808e9d1f4f49bc9e3767f90feacbd152.zip | |
Rollup merge of #76730 - ebkalderon:rustdoc-fix-mut-args-async-fn, r=tmandry
Fix rustdoc rendering of by-value mutable arguments in async fn r? `@jyn514` Fixes #76517.
| -rw-r--r-- | compiler/rustc_ast_lowering/src/item.rs | 14 | ||||
| -rw-r--r-- | src/test/rustdoc/async-fn.rs | 14 | ||||
| -rw-r--r-- | src/test/rustdoc/const-generics/const-generics-docs.rs | 3 |
3 files changed, 27 insertions, 4 deletions
diff --git a/compiler/rustc_ast_lowering/src/item.rs b/compiler/rustc_ast_lowering/src/item.rs index 617cacee0e7..d353bc19f7a 100644 --- a/compiler/rustc_ast_lowering/src/item.rs +++ b/compiler/rustc_ast_lowering/src/item.rs @@ -1096,8 +1096,18 @@ impl<'hir> LoweringContext<'_, 'hir> { // Check if this is a binding pattern, if so, we can optimize and avoid adding a // `let <pat> = __argN;` statement. In this case, we do not rename the parameter. let (ident, is_simple_parameter) = match parameter.pat.kind { - hir::PatKind::Binding(hir::BindingAnnotation::Unannotated, _, ident, _) => { - (ident, true) + hir::PatKind::Binding( + hir::BindingAnnotation::Unannotated | hir::BindingAnnotation::Mutable, + _, + ident, + _, + ) => (ident, true), + // For `ref mut` or wildcard arguments, we can't reuse the binding, but + // we can keep the same name for the parameter. + // This lets rustdoc render it correctly in documentation. + hir::PatKind::Binding(_, _, ident, _) => (ident, false), + hir::PatKind::Wild => { + (Ident::with_dummy_span(rustc_span::symbol::kw::Underscore), false) } _ => { // Replace the ident for bindings that aren't simple. diff --git a/src/test/rustdoc/async-fn.rs b/src/test/rustdoc/async-fn.rs index 5a03e821e8a..e7a7d1831f7 100644 --- a/src/test/rustdoc/async-fn.rs +++ b/src/test/rustdoc/async-fn.rs @@ -1,4 +1,5 @@ // edition:2018 +#![feature(min_const_generics)] // @has async_fn/fn.foo.html '//pre[@class="rust fn"]' 'pub async fn foo() -> Option<Foo>' pub async fn foo() -> Option<Foo> { @@ -20,6 +21,12 @@ pub async unsafe fn qux() -> char { '⚠' } +// @has async_fn/fn.mut_args.html '//pre[@class="rust fn"]' 'pub async fn mut_args(a: usize)' +pub async fn mut_args(mut a: usize) {} + +// @has async_fn/fn.mut_ref.html '//pre[@class="rust fn"]' 'pub async fn mut_ref(x: i32)' +pub async fn mut_ref(ref mut x: i32) {} + trait Bar {} impl Bar for () {} @@ -32,9 +39,16 @@ pub async fn quux() -> impl Bar { // @has async_fn/struct.Foo.html // @matches - '//code' 'pub async fn f\(\)$' // @matches - '//code' 'pub async unsafe fn g\(\)$' +// @matches - '//code' 'pub async fn mut_self\(self, first: usize\)$' pub struct Foo; impl Foo { pub async fn f() {} pub async unsafe fn g() {} + pub async fn mut_self(mut self, mut first: usize) {} } + +pub trait Trait<const N: usize> {} +// @has async_fn/fn.const_generics.html +// @has - '//pre[@class="rust fn"]' 'pub async fn const_generics<const N: usize>(_: impl Trait<N>)' +pub async fn const_generics<const N: usize>(_: impl Trait<N>) {} diff --git a/src/test/rustdoc/const-generics/const-generics-docs.rs b/src/test/rustdoc/const-generics/const-generics-docs.rs index 8dcba36600d..9c68e067c6f 100644 --- a/src/test/rustdoc/const-generics/const-generics-docs.rs +++ b/src/test/rustdoc/const-generics/const-generics-docs.rs @@ -70,8 +70,7 @@ pub async fn a_sink<const N: usize>(v: [u8; N]) -> impl Trait<N> { } // @has foo/fn.b_sink.html '//pre[@class="rust fn"]' \ -// 'pub async fn b_sink<const N: usize>(__arg0: impl Trait<N>)' -// FIXME(const_generics): This should be `_` not `__arg0`. +// 'pub async fn b_sink<const N: usize>(_: impl Trait<N>)' pub async fn b_sink<const N: usize>(_: impl Trait<N>) {} // @has foo/fn.concrete.html '//pre[@class="rust fn"]' \ |
