Add RTN support to rustdoc #137956

compiler-errors · 2025-03-03T19:09:25Z

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:

pub fn foreign<T: Foreign<bar(..): Send>>()
where
    <T as Foreign>::bar(..): 'static,
    T::bar(..): Sync,

Into this:

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 #123996 (i.e., HIR side, not middle::ty one)

rustbot · 2025-03-03T19:09:29Z

r? @fmease

rustbot has assigned @fmease.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

rustbot · 2025-03-03T19:09:32Z

rustdoc-json-types is a public (although nightly-only) API. If possible, consider changing src/librustdoc/json/conversions.rs; otherwise, make sure you bump the FORMAT_VERSION constant.

cc @CraftSpider, @aDotInTheVoid, @Enselic, @obi1kenobi

Some changes occurred in tests/rustdoc-json

cc @aDotInTheVoid

…2, r=jieyouxu triagebot.toml: Don't label `test/rustdoc-json` as A-rustdoc-search This happened because `test/rustdoc-js` is a prefix of `test/rustdoc-json`, and triagebot works on prefixes. Maybe this should be fixed in triagebot, but this works now. This happened on rust-lang#137956 and rust-lang#137955.

Rollup merge of rust-lang#137958 - aDotInTheVoid:aDotInTheVoid-patch-2, r=jieyouxu triagebot.toml: Don't label `test/rustdoc-json` as A-rustdoc-search This happened because `test/rustdoc-js` is a prefix of `test/rustdoc-json`, and triagebot works on prefixes. Maybe this should be fixed in triagebot, but this works now. This happened on rust-lang#137956 and rust-lang#137955.

bors · 2025-03-07T17:52:00Z

☔ The latest upstream changes (presumably #138155) made this pull request unmergeable. Please resolve the merge conflicts.

aDotInTheVoid · 2025-03-08T00:27:27Z

src/rustdoc-json-types/lib.rs

@@ -30,7 +30,7 @@ pub type FxHashMap<K, V> = HashMap<K, V>; // re-export for use in src/librustdoc
 /// This integer is incremented with every breaking change to the API,
 /// and is returned along with the JSON blob as [`Crate::format_version`].
 /// Consuming code should assert that this value matches the format version(s) that it supports.
-pub const FORMAT_VERSION: u32 = 40;
+pub const FORMAT_VERSION: u32 = 41;


This is taking place at the same time as #138109, which also (currently) makes the 40->41 change. Once one of these merges, the other should rebase then bump again. See #94591 for details.

compiler-errors · 2025-03-11T23:18:17Z

src/rustdoc-json-types/lib.rs

@@ -30,7 +30,7 @@ pub type FxHashMap<K, V> = HashMap<K, V>; // re-export for use in src/librustdoc
 /// This integer is incremented with every breaking change to the API,
 /// and is returned along with the JSON blob as [`Crate::format_version`].
 /// Consuming code should assert that this value matches the format version(s) that it supports.
-pub const FORMAT_VERSION: u32 = 40;
+pub const FORMAT_VERSION: u32 = 41;


Suggested change

pub const FORMAT_VERSION: u32 = 41;

pub const FORMAT_VERSION: u32 = 42;

fmease · 2025-03-12T19:02:05Z

Sorry for the wait, looks good! r=me after rebase, version bump once #138109 is merged.

I'll keep #123996 open until we figure out the middle::ty situation (and I'll update its description) (also cc #113015).

@bors rollup

fmease · 2025-03-14T16:22:33Z

Blocking PR #138109 has been merged. Unblocked.

compiler-errors · 2025-03-15T18:13:53Z

bumped to version 42

@bors r=fmease

bors · 2025-03-15T18:13:55Z

📌 Commit e3ac1fa has been approved by fmease

It is now in the queue for this repository.

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)

Rollup of 16 pull requests Successful merges: - rust-lang#133055 (Expand `CloneToUninit` documentation.) - rust-lang#137147 (Add exclude to config.toml) - rust-lang#137864 (Don't drop `Rvalue::WrapUnsafeBinder` during GVN) - rust-lang#137890 (doc: clarify that consume can be called after BufReader::peek) - rust-lang#137956 (Add RTN support to rustdoc) - rust-lang#137968 (Properly escape regexes in Python scripts) - rust-lang#138082 (Remove `#[cfg(not(test))]` gates in `core`) - rust-lang#138275 (expose `is_s390x_feature_detected!` from `std::arch`) - rust-lang#138303 (Fix Ptr inconsistency in {Rc,Arc}) - rust-lang#138309 (Add missing doc for intrinsic (Fix PR135334)) - rust-lang#138323 (Expand and organize `offset_of!` documentation.) - rust-lang#138329 (debug-assert that the size_hint is well-formed in `collect`) - rust-lang#138465 (linkchecker: bump html5ever) - rust-lang#138471 (Clean up some tests in tests/ui) - rust-lang#138472 (Add codegen test for rust-lang#129795) - rust-lang#138484 (Use lit span when suggesting suffix lit cast) r? `@ghost` `@rustbot` modify labels: rollup

rustbot assigned fmease Mar 3, 2025

aDotInTheVoid mentioned this pull request Mar 3, 2025

triagebot.toml: Don't label test/rustdoc-json as A-rustdoc-search #137958

Merged

aDotInTheVoid added F-return_type_notation `#[feature(return_type_notation)]` and removed A-rustdoc-search Area: Rustdoc's search feature T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Mar 3, 2025

aDotInTheVoid reviewed Mar 8, 2025

View reviewed changes

This was referenced Mar 8, 2025

rustdoc-json: Guard agains 2 commits making the same modification to FORMAT_VERSION #94591

Open

make precise capturing args in rustdoc Json typed #138109

Merged

compiler-errors commented Mar 11, 2025

View reviewed changes

fmease approved these changes Mar 12, 2025

View reviewed changes

compiler-errors mentioned this pull request Mar 12, 2025

Stabilize return type notation (RFC 3654) #138424

Open

4 tasks

fmease removed the S-blocked Status: Blocked on something else such as an RFC or other implementation work. label Mar 14, 2025

Add RTN support to rustdoc

e3ac1fa

compiler-errors force-pushed the rtn-rustdoc branch from c95ee4d to e3ac1fa Compare March 15, 2025 18:13

rustbot added the T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. label Mar 15, 2025

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 15, 2025

jieyouxu mentioned this pull request Mar 16, 2025

Rollup of 16 pull requests #138548

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add RTN support to rustdoc #137956

Add RTN support to rustdoc #137956

compiler-errors commented Mar 3, 2025 •

edited by fmease

Loading

rustbot commented Mar 3, 2025

rustbot commented Mar 3, 2025

bors commented Mar 7, 2025

aDotInTheVoid Mar 8, 2025

compiler-errors Mar 11, 2025

fmease commented Mar 12, 2025 •

edited

Loading

fmease commented Mar 14, 2025

compiler-errors commented Mar 15, 2025

bors commented Mar 15, 2025

	pub const FORMAT_VERSION: u32 = 41;
	pub const FORMAT_VERSION: u32 = 42;

Add RTN support to rustdoc #137956

Are you sure you want to change the base?

Add RTN support to rustdoc #137956

Conversation

compiler-errors commented Mar 3, 2025 • edited by fmease Loading

rustbot commented Mar 3, 2025

rustbot commented Mar 3, 2025

bors commented Mar 7, 2025

aDotInTheVoid Mar 8, 2025

Choose a reason for hiding this comment

compiler-errors Mar 11, 2025

Choose a reason for hiding this comment

fmease commented Mar 12, 2025 • edited Loading

fmease commented Mar 14, 2025

compiler-errors commented Mar 15, 2025

bors commented Mar 15, 2025

compiler-errors commented Mar 3, 2025 •

edited by fmease

Loading

fmease commented Mar 12, 2025 •

edited

Loading