Rustdoc render async function re-export #64599

csmoe · 2019-09-19T03:33:24Z

Closes #63710
r? @nikomatsakis

Centril · 2019-09-19T16:43:39Z

Won't this still render with -> impl Trait?

csmoe · 2019-09-19T16:46:41Z

@Centril fixing associate_method, build_external_function seems not the one to blame.

nikomatsakis

This looks great, thanks @csmoe!

One question: can we adjust the query to be fn asyncness() instead of fn is_async_fn()?

src/librustdoc/clean/inline.rs

src/librustdoc/clean/mod.rs

nikomatsakis

Oh, one other thing:

We don't have any test for this! Can you add a test?

Here is an example of such a test for async-fn (crate-local only, obviously):

https://github.com/rust-lang/rust/blob/master/src/test/rustdoc/async-fn.rs

and this is an example testing the cross-crate case specifically:

https://github.com/rust-lang/rust/blob/master/src/test/rustdoc/cross-crate-links.rs

but maybe @QuietMisdreavus can give some better examples of just the tests we want in this case.

(This is for the bug around async fn across crates, @QuietMisdreavus)

src/test/rustdoc/inline_cross/auxiliary/impl_trait_aux.rs

csmoe · 2019-09-21T08:41:28Z

@nikomatsakis I added the tests into https://github.com/rust-lang/rust/blob/master/src/test/rustdoc/inline_cross/impl_trait.rs as it covers bare function and impl re-exports.

nikomatsakis

@csmoe great, thanks! I left a few more (quite small) nits.

r=me once fixed

src/librustc/ty/mod.rs

src/librustc_metadata/decoder.rs

nikomatsakis · 2019-09-24T14:39:04Z

@bors r+

bors · 2019-09-24T14:39:06Z

📌 Commit a744fd0 has been approved by nikomatsakis

nikomatsakis · 2019-09-24T14:42:23Z

I'm assuming this will not make the 1.39 beta cutoff. If so, I think we should consider backporting it, as it resolves a "quality" issue for async await. Basically, the rustdoc for library facades that make use of async fn looks bad (it doesn't show that they are async fn). I wouldn't ordinarily nominate such a thing for backport, I don't think, but since async fn is a high priority feature, we can expect a lot of eyes on it, so I think it might be worth considering.

Centril · 2019-09-24T14:45:58Z

Yep, this won't make it to the cutoff as @Mark-Simulacrum is branching master to beta in an hour or so. Backporting this seems rather safe so it is reasonable I'd say.

@nikomatsakis

…sakis Rustdoc render async function re-export Closes rust-lang#63710 r? @nikomatsakis

@ghost

Rollup of 7 pull requests Successful merges: - #64324 (rustc: Fix mixing crates with different `share_generics`) - #64428 (Error explanation e0524) - #64481 (A more explanatory thread local storage panic message) - #64599 (Rustdoc render async function re-export) - #64743 (Update cargo) - #64746 (Remove blanket silencing of "type annotation needed" errors) - #64753 (Don't emit explain with json short messages.) Failed merges: r? @ghost

pnkfelix · 2019-09-26T14:20:23Z

discussed at T-compiler meeting. Approved for beta backport.

…port

[beta] switch to stable bootstrap and rollup backports Contains the following: * Account for the Zero sub-pattern case. #64748 * relnotes: make compatibility section more sterile and fix rustc version #64742 * Rustdoc render async function re-export #64599 * Update cargo #64773 * switches us to stable bootstrap (not dev-static) (no PR)

add is_async_fn query

2fd4c27

rust-highfive assigned nikomatsakis Sep 19, 2019

csmoe force-pushed the doc_async_reexport branch from 042503e to ab3fcc0 Compare September 19, 2019 05:55

csmoe force-pushed the doc_async_reexport branch from ab3fcc0 to 73f5bac Compare September 19, 2019 16:59

This comment has been minimized.

# to view

append asyncness info to functions

9ffb1ce

csmoe force-pushed the doc_async_reexport branch from 73f5bac to 9ffb1ce Compare September 19, 2019 18:39

nikomatsakis requested changes Sep 20, 2019

View reviewed changes

src/librustdoc/clean/inline.rs Outdated Show resolved Hide resolved

src/librustdoc/clean/mod.rs Outdated Show resolved Hide resolved

nikomatsakis requested changes Sep 20, 2019

View reviewed changes

JohnCSimon added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Sep 21, 2019

rename is_async_fn to asyncness

a813cc1

tesuji reviewed Sep 21, 2019

View reviewed changes

src/test/rustdoc/inline_cross/auxiliary/impl_trait_aux.rs Outdated Show resolved Hide resolved

add rustdoc test for async fn reexport

726fe3b

csmoe force-pushed the doc_async_reexport branch from bf04111 to 726fe3b Compare September 21, 2019 08:34

csmoe added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 23, 2019

nikomatsakis requested changes Sep 23, 2019

View reviewed changes

src/librustc/ty/mod.rs Outdated Show resolved Hide resolved

src/librustc/ty/mod.rs Outdated Show resolved Hide resolved

src/librustc_metadata/decoder.rs Outdated Show resolved Hide resolved

csmoe force-pushed the doc_async_reexport branch 2 times, most recently from a1587c5 to 04ffef1 Compare September 23, 2019 17:21

This comment has been minimized.

# to view

bug-out asyncness query on non-local funtions

a744fd0

csmoe force-pushed the doc_async_reexport branch from 04ffef1 to a744fd0 Compare September 24, 2019 06:18

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 24, 2019

nikomatsakis added beta-nominated Nominated for backporting to the compiler in the beta channel. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Sep 24, 2019

Centril added a commit to Centril/rust that referenced this pull request Sep 25, 2019

Rollup merge of rust-lang#64599 - csmoe:doc_async_reexport, r=nikomat…

34067ee

…sakis Rustdoc render async function re-export Closes rust-lang#63710 r? @nikomatsakis

Centril mentioned this pull request Sep 25, 2019

Rollup of 7 pull requests #64754

Merged

bors merged commit a744fd0 into rust-lang:master Sep 25, 2019

pnkfelix added the beta-accepted Accepted for backporting to the compiler in the beta channel. label Sep 26, 2019

Mark-Simulacrum pushed a commit to Mark-Simulacrum/rust that referenced this pull request Sep 26, 2019

Backport rust-lang#64599 to beta: rustdoc render async function re-ex…

2ff6c65

…port

Mark-Simulacrum mentioned this pull request Sep 26, 2019

[beta] switch to stable bootstrap and rollup backports #64814

Merged

Mark-Simulacrum removed the beta-nominated Nominated for backporting to the compiler in the beta channel. label Sep 26, 2019

Rustdoc render async function re-export #64599

Rustdoc render async function re-export #64599

Uh oh!

Conversation

csmoe commented Sep 19, 2019

Uh oh!

Centril commented Sep 19, 2019

Uh oh!

csmoe commented Sep 19, 2019

Uh oh!

This comment has been minimized.

This comment has been minimized.

nikomatsakis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nikomatsakis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

csmoe commented Sep 21, 2019

Uh oh!

nikomatsakis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

nikomatsakis commented Sep 24, 2019

Uh oh!

bors commented Sep 24, 2019

Uh oh!

nikomatsakis commented Sep 24, 2019

Uh oh!

Centril commented Sep 24, 2019

Uh oh!

pnkfelix commented Sep 26, 2019

Uh oh!

Uh oh!