rustdoc: support RTN once its syntax is somewhat finalized #123996
Assignees
Labels
C-bug
Category: This is a bug.
F-return_type_notation
`#[feature(return_type_notation)]`
P-low
Low priority
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Comments
fmease
added
T-rustdoc
rustbot
added
the
needs-triage
fmease
removed
the
needs-triage
fmease
removed
the
S-blocked
4 tasks
jieyouxu
added a commit
to jieyouxu/rust
that referenced
this issue
Mar 16, 2025
Add RTN support to rustdoc
This adds support to rustdoc and rustdoc-json for rendering `(..)` RTN (return type notation) style generics.
---
Cleaning `rustc_middle::ty::Ty` is not correct still, though, and ends up rendering a function like:
```rust
pub fn foreign<T: Foreign<bar(..): Send>>()
where
<T as Foreign>::bar(..): 'static,
T::bar(..): Sync,
```
Into this:
```rust
pub fn foreign<T>()
where
T: Foreign,
impl Future<Output = ()>: Send + 'static + Sync,
```
This is because `clean_middle_ty` doesn't actually have sufficient context about whether the RPITIT is in its "defining scope" or not, so we don't know if the type was originally written like `-> impl Trait` or with RTN like `T::method(..)`.
Partially addresses rust-lang#123996 (i.e., HIR side, not middle::ty one)
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this issue
Mar 16, 2025
Rollup merge of rust-lang#137956 - compiler-errors:rtn-rustdoc, r=fmease Add RTN support to rustdoc This adds support to rustdoc and rustdoc-json for rendering `(..)` RTN (return type notation) style generics. --- Cleaning `rustc_middle::ty::Ty` is not correct still, though, and ends up rendering a function like: ```rust pub fn foreign<T: Foreign<bar(..): Send>>() where <T as Foreign>::bar(..): 'static, T::bar(..): Sync, ``` Into this: ```rust pub fn foreign<T>() where T: Foreign, impl Future<Output = ()>: Send + 'static + Sync, ``` This is because `clean_middle_ty` doesn't actually have sufficient context about whether the RPITIT is in its "defining scope" or not, so we don't know if the type was originally written like `-> impl Trait` or with RTN like `T::method(..)`. Partially addresses rust-lang#123996 (i.e., HIR side, not middle::ty one)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This is blocked by T-lang's decision on the final syntax of RTN!Unblocked (IINM)Source:
Current rendered output of
f(local scenario, HIR-based cleaning):Current rendered output of
f(inlined cross-crate re-export scenario, rustc_middle::ty-based cleaning):The text was updated successfully, but these errors were encountered: