Fnty args rustdoc #44892

GuillaumeGomez · 2017-09-27T20:57:16Z

cc @QuietMisdreavus
cc @rust-lang/dev-tools

Considering the impact on the hir libs, I'll put @eddyb as reviewer.

eddyb · 2017-09-28T10:46:00Z

src/librustc/hir/mod.rs

@@ -1426,7 +1426,7 @@ pub enum Ty_ {
    /// A reference (`&'a T` or `&'a mut T`)
    TyRptr(Lifetime, MutTy),
    /// A bare function (e.g. `fn(usize) -> bool`)
-    TyBareFn(P<BareFnTy>),
+    TyBareFn(P<BareFnTy>, HirVec<Spanned<Name>>),


When we discussed it, you were supposed to put it in BareFnTy. That should simplify things.

Ah damn, got tricked by this message.

GuillaumeGomez · 2017-09-28T18:44:09Z

Updated.

eddyb · 2017-09-28T18:47:41Z

src/librustc/hir/mod.rs

@@ -1412,6 +1412,7 @@ pub struct BareFnTy {
    pub abi: Abi,
    pub lifetimes: HirVec<LifetimeDef>,
    pub decl: P<FnDecl>,
+    pub args_name: HirVec<Spanned<Name>>,


arg_names

eddyb · 2017-09-28T18:48:22Z

src/librustdoc/clean/mod.rs

@@ -1244,12 +1244,25 @@ impl<'a> Clean<Arguments> for (&'a [P<hir::Ty>], hir::BodyId) {
    }
 }

-impl<'a, A: Copy> Clean<FnDecl> for (&'a hir::FnDecl, A)
+impl<'a> Clean<Arguments> for (&'a [P<hir::Ty>], Vec<String>) {


Changing this impl means you've done something wrong...

eddyb · 2017-09-28T18:48:54Z

src/librustdoc/clean/mod.rs

@@ -1927,7 +1940,34 @@ impl Clean<Type> for hir::Ty {
                    _ => Infer // shouldn't happen
                }
            }
-            TyBareFn(ref barefn) => BareFunction(box barefn.clean(cx)),


BareFnTy has its own Clean impl, you should be changing that, not this - this is why I didn't want you to change the enum variant, but the struct.

GuillaumeGomez · 2017-10-04T12:04:43Z

Updated.

eddyb · 2017-10-04T16:32:14Z

src/librustdoc/clean/mod.rs

                BareFunction(box BareFunctionDecl {
                    unsafety: sig.unsafety(),
                    generics: Generics {
                        lifetimes: Vec::new(),
                        type_params: Vec::new(),
                        where_predicates: Vec::new()
                    },
-                    decl: (cx.tcx.hir.local_def_id(ast::CRATE_NODE_ID), sig).clean(cx),
+                    decl: decl,


Why was this moved at all?

eddyb · 2017-10-04T16:33:28Z

src/librustdoc/clean/mod.rs

@@ -2491,7 +2505,23 @@ impl Clean<BareFunctionDecl> for hir::BareFnTy {
                type_params: Vec::new(),
                where_predicates: Vec::new()
            },
-            decl: (&*self.decl, &[][..]).clean(cx),


The existing impls are already powerful enough for this (unless I wasn't careful), all you need is to replace &[][..] with &self.arg_names.

Not exactly:

no method named `clean` found for type `(&rustc::hir::FnDecl, &syntax::ptr::P<[syntax::codemap::Spanned<syntax::ast::Symbol>]>)` in the current scope --> src/librustdoc/clean/mod.rs:2507:50 | 2507 | decl: (&*self.decl, &self.arg_names).clean(cx), | ^^^^^ | = note: the method `clean` exists but the following trait bounds were not satisfied: `(&[syntax::ptr::P<rustc::hir::Ty>], &syntax::ptr::P<[syntax::codemap::Spanned<syntax::ast::Symbol>]>) : clean::Clean<clean::Arguments>` = help: items from traits can only be used if the trait is implemented and in scope = note: the following trait defines an item `clean`, perhaps you need to implement it: candidate #1: `clean::Clean`

Sounds like you need &self.arg_names[..] instead?

Like, look for ForeignItemFn, it starts off with the same information but it doesn't implement the cleaning itself.

GuillaumeGomez · 2017-10-07T15:37:24Z

Updated.

eddyb · 2017-10-07T15:47:23Z

@bors r+

bors · 2017-10-07T15:47:25Z

📌 Commit fe24e81 has been approved by eddyb

bors · 2017-10-07T19:39:38Z

⌛ Testing commit fe24e81 with merge 05f8ddc...

@QuietMisdreavus

Fnty args rustdoc Fixes #44570. cc @QuietMisdreavus cc @rust-lang/dev-tools Considering the impact on the `hir` libs, I'll put @eddyb as reviewer. r? @eddyb

bors · 2017-10-07T22:18:16Z

☀️ Test successful - status-appveyor, status-travis
Approved by: eddyb
Pushing 05f8ddc to master...

rust-highfive assigned eddyb Sep 27, 2017

aidanhs added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 28, 2017

eddyb reviewed Sep 28, 2017

View reviewed changes

GuillaumeGomez force-pushed the fnty-args-rustdoc branch from a644487 to 075c90a Compare September 28, 2017 18:43

eddyb reviewed Sep 28, 2017

View reviewed changes

GuillaumeGomez mentioned this pull request Sep 28, 2017

Generate dox feature as well gtk-rs/gir#470

Merged

GuillaumeGomez force-pushed the fnty-args-rustdoc branch from 075c90a to 81c2eff Compare September 29, 2017 20:59

eddyb reviewed Oct 4, 2017

View reviewed changes

Add names to BareFnTy

3493c62

GuillaumeGomez force-pushed the fnty-args-rustdoc branch 2 times, most recently from 1b80222 to 56c3dda Compare October 7, 2017 14:51

Fix invalid rustdoc rendering for FnTy args

fe24e81

GuillaumeGomez force-pushed the fnty-args-rustdoc branch from 56c3dda to fe24e81 Compare October 7, 2017 15:23

bors merged commit fe24e81 into rust-lang:master Oct 7, 2017

GuillaumeGomez deleted the fnty-args-rustdoc branch October 8, 2017 13:46

Fnty args rustdoc #44892

Fnty args rustdoc #44892

Uh oh!

Conversation

GuillaumeGomez commented Sep 27, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Sep 28, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Oct 4, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Oct 7, 2017

Uh oh!

eddyb commented Oct 7, 2017

Uh oh!

bors commented Oct 7, 2017

Uh oh!

bors commented Oct 7, 2017

Uh oh!

bors commented Oct 7, 2017

Uh oh!

Uh oh!