HACKY/INCOMPLETE: Add implied bounds to rustdoc-json #142264
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
rustbot has assigned @Mark-Simulacrum. Use |
rustbot
added
A-compiletest
|
Some changes occurred in src/tools/compiletest cc @jieyouxu These commits modify Please ensure that if you've changed the output:
|
|
r? @ghost |
This comment has been minimized.
This comment has been minimized.
fmease
reviewed
Jun 9, 2025
There was a problem hiding this comment.
Only works on structs. […]
I don't think this isn't fundamental, but should be doable with more work.
It is "fundamental" in that it doesn't work for functions which is the real question here. CC Jubilee's mention of implicit implied outlives-bounds.
For functions, predicates_of (more specifically, inferred_outlives_of which is called under the hood) does not include implied outlives-bounds. CC https://rustc-dev-guide.rust-lang.org/traits/implied-bounds.html#implicit-implied-bounds
| generics: clean_ty_generics( | ||
| cx, | ||
| cx.tcx.generics_of(def_id), | ||
| cx.tcx.predicates_of(def_id), |
There was a problem hiding this comment.
Right. predicates_of contains the (explicit) implied bounds because it's explicit_predicates_of + inferred_outlives_of.
I would just call inferred_outlives_of separately and not call predicates_of here. This way, implied bounds can be marked as implied.
There was a problem hiding this comment.
d'oh that's much nicer, and solves all the problems with this approach, as we also get to keep using HIR for HTML!
rust-cloud-vms
bot
force-pushed
the
rustdoc-ty-generics
branch
from
a5cf688 to
1d077d3
Compare
aDotInTheVoid
removed
T-bootstrap
|
Closing, as not the right approach. |
workingjubilee
added a commit
to workingjubilee/rustc
that referenced
this pull request
Jun 10, 2025
rustdoc: Refractor `clean_ty_generics` Refactoring towards rust-lang#142226 [Zulip Discussion](https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/Why.20sometimes.20.60predicates_of.60.20.28vs.20.60explicit_predicates_.2E.2E.2E/near/523182529) The old `clean_ty_generics` was almost always called with the same args, so rename it to `clean_ty_generics_inner`, and add a new wrapper that generates those args from a `DefId`. Having this be the main entrypoint to `clean_ty_generics` should make it easier to start calling `inferred_outlives_of` rust-lang#142264 (comment) (and is more readable even if we don't) Also, replaces all calls in rustdoc to `tcx.predicates_of` to `tcx.explicit_predicates_of`, which lets us remove `filter_non_trait_generics` r? `@fmease`
workingjubilee
added a commit
to workingjubilee/rustc
that referenced
this pull request
Jun 10, 2025
rustdoc: Refractor `clean_ty_generics` Refactoring towards rust-lang#142226 [Zulip Discussion](https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/Why.20sometimes.20.60predicates_of.60.20.28vs.20.60explicit_predicates_.2E.2E.2E/near/523182529) The old `clean_ty_generics` was almost always called with the same args, so rename it to `clean_ty_generics_inner`, and add a new wrapper that generates those args from a `DefId`. Having this be the main entrypoint to `clean_ty_generics` should make it easier to start calling `inferred_outlives_of` rust-lang#142264 (comment) (and is more readable even if we don't) Also, replaces all calls in rustdoc to `tcx.predicates_of` to `tcx.explicit_predicates_of`, which lets us remove `filter_non_trait_generics` r? ``@fmease``
fmease
added a commit
to fmease/rust
that referenced
this pull request
Jun 10, 2025
rustdoc: Refractor `clean_ty_generics` Refactoring towards rust-lang#142226 [Zulip Discussion](https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/Why.20sometimes.20.60predicates_of.60.20.28vs.20.60explicit_predicates_.2E.2E.2E/near/523182529) The old `clean_ty_generics` was almost always called with the same args, so rename it to `clean_ty_generics_inner`, and add a new wrapper that generates those args from a `DefId`. Having this be the main entrypoint to `clean_ty_generics` should make it easier to start calling `inferred_outlives_of` rust-lang#142264 (comment) (and is more readable even if we don't) Also, replaces all calls in rustdoc to `tcx.predicates_of` to `tcx.explicit_predicates_of`, which lets us remove `filter_non_trait_generics` r? ```@fmease```
rust-timer
added a commit
that referenced
this pull request
Jun 10, 2025
Rollup merge of #142275 - aDotInTheVoid:gen-ty-of, r=fmease rustdoc: Refractor `clean_ty_generics` Refactoring towards #142226 [Zulip Discussion](https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/Why.20sometimes.20.60predicates_of.60.20.28vs.20.60explicit_predicates_.2E.2E.2E/near/523182529) The old `clean_ty_generics` was almost always called with the same args, so rename it to `clean_ty_generics_inner`, and add a new wrapper that generates those args from a `DefId`. Having this be the main entrypoint to `clean_ty_generics` should make it easier to start calling `inferred_outlives_of` #142264 (comment) (and is more readable even if we don't) Also, replaces all calls in rustdoc to `tcx.predicates_of` to `tcx.explicit_predicates_of`, which lets us remove `filter_non_trait_generics` r? ```@fmease```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A hackattempt at #142226. CC @obi1kenobi @workingjubilee @fmease
This is a meant to show it's possible. The version that lands will probably be a new PR that learns from this.
How
Hir doesn't have implied bounds, so we need to get generics from
ty. Rustdoc already has a codepath for that, but it's not the default becausetyis far more normalized, so the HTML output is farther from what the user wrote.Limitations
Only works on structs. Fixable by replacing all calls to
clean_genericswith calls toclean_ty_generics, so we only get generics fromty. Also would require replacing all calls totcx.explicit_predicates_ofto justpredicates_of.I don't think this isn't fundamental, but should be doable with more work.
Doesn't differentiate implied vs explicit bounds. This is necessary for json (rustdoc-json: Show implied outlives-bounds #142226 (comment)), and pretty desirable for HTML
Makes the HTML output """worse""" (for some definition of worse)