-
Notifications
You must be signed in to change notification settings - Fork 13.2k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Query docs show return types as <query_name as QueryConfig<TyCtxt<'tcx>>>::Stored
#77459
Comments
|
I'm not sure what's going on with |
I think the difference is that |
Maybe the fix should be for rustdoc to turn |
Re-opening this until I fix #79459 properly. |
…n1011 Remove unnecessary `mut` binding Found while fiddling around with rust-lang#77459.
…illaumeGomez Add -Z normalize-docs and enable it for compiler docs Works around rust-lang#79459 by only enabling normalization for the compiler itself (and anyone who opts-in on nightly). Eventually I want to remove this and enable normalization by default, but that's turned out to be [really hard](https://rust-lang.zulipchat.com/#narrow/stream/182449-t-compiler.2Fhelp/topic/How.20do.20I.20normalize.20projection.20types.20to.20a.20single.20type.3F/near/218125195). This uses a command line option instead of a feature gate so it's easier to pass it to all crates at once. Theoretically it's better to use a feature gate instead so that it's easier for people to use on docs.rs, but I'm also not terribly concerned with how easy it to use a temporary hack. Addresses rust-lang#77459.
…illaumeGomez Add -Z normalize-docs and enable it for compiler docs Works around rust-lang#79459 by only enabling normalization for the compiler itself (and anyone who opts-in on nightly). Eventually I want to remove this and enable normalization by default, but that's turned out to be [really hard](https://rust-lang.zulipchat.com/#narrow/stream/182449-t-compiler.2Fhelp/topic/How.20do.20I.20normalize.20projection.20types.20to.20a.20single.20type.3F/near/218125195). This uses a command line option instead of a feature gate so it's easier to pass it to all crates at once. Theoretically it's better to use a feature gate instead so that it's easier for people to use on docs.rs, but I'm also not terribly concerned with how easy it to use a temporary hack. Addresses rust-lang#77459.
This was fixed for rustc by #79525. I guess we can reuse this as the tracking issue for enabling |
Closing this in favor of #82692, which has proper links and such so it's clear what this is blocked on. |
e.g. https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/ty/struct.TyCtxt.html#method.hir_crate
This makes the docs really hard to read: you have to click on
hir_crate
, openimpl<'tcx> QueryConfig<TyCtxt<'tcx>> for hir_crate
, and know thatValue
is what actually matters, notStored
. This is super confusing and not documented anywhere. We should find a way to just put&'tcx Crate<'tcx>
directly in the return type instead.The text was updated successfully, but these errors were encountered: