-
Notifications
You must be signed in to change notification settings - Fork 12.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Stabilize #[doc_alias = "..."] #63236
Stabilize #[doc_alias = "..."] #63236
Conversation
f80b055
to
79a3044
Compare
79a3044
to
95f9be0
Compare
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
Hum, interesting issue: we need cc @rust-lang/compiler |
I would also expect stabilization PRs to come with a report of the usage of the feature, even if brief -- how long has it been unstable for, what is the usage like in the wild. In particular, in this case it seems like this feature is missing documentation about the namespace we're aliasing items in the documentation to. If this is purely for search, then naming it simply "alias" feels too broad. |
I think it's up to the |
Admittedly i've not have any experience on this, but how does this feature works? I mean, if in a crate X there a Foo that aliased to Y, does this mean when i search either |
@crlf0710 Aliases work at the crate level. So if you can a crate |
Ping from triage: @ollie27 @GuillaumeGomez any updates on this? |
I still need to check how to be able to actually stabilize this since we need it to be stable to stabilize it (I love paradoxes). |
Ping from Triage: Hi @GuillaumeGomez - what is the status of your paradox? |
Didn't check yet (going through my other PRs for the moment). |
Ping from triage Thank you! |
The merge conflict is minor. What I need to do is fix the paradox issue first. Will do as soon as I have enough time! |
Ping from triage: |
Waiting for approval first. A bit annoying to keep updating whereas there is no review... |
Does anyone want to use this outside the standard library? I was under the impression that the purpose of this feature was to search for the operator traits via the operator itself. I could see this being used to associate a type with a common misnomer for it, but i'm not sure if anyone has thought to properly encode something like that. I'm just not sure this feature will see much use outside the standard library, and if that's the case we should just keep it perma-unstable. As for your "paradox", @Mark-Simulacrum already solved it for you. Replace the |
@QuietMisdreavus Yes, @Mark-Simulacrum told me but thanks for the update! As for its usage outside of libstd, I'd like to use it on gtk-rs (because we have to prepend some types with the lib name to avoid conflicts). |
@GuillaumeGomez So you need to name the item something like |
The naming won't change, even if you limit the search to a specific crate. For example, we have However, for crates heavily using proc macros, it'd make much more sense since they can provide a completely new syntax. |
Ping from triage: @ollie27 could you review this? |
@@ -854,6 +851,8 @@ declare_features! ( | |||
(accepted, repr_align_enum, "1.37.0", Some(57996), None), | |||
// Allows `const _: TYPE = VALUE`. | |||
(accepted, underscore_const_names, "1.37.0", Some(54912), None), | |||
// Allows `#[doc(alias = "...")]`. | |||
(accepted, doc_alias, "1.27.0", Some(50146), None), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(accepted, doc_alias, "1.27.0", Some(50146), None), | |
(accepted, doc_alias, "1.41.0", Some(50146), None), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sill waiting for approval before rebasing. It's just one of the conflicts. ;)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hehe; I just did this for all 1.40.0 PRs that were relevant ^^
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:p
Ping from triage: assigning another reviewer randomly... |
I think this should be closed for now to keep the PR queue clean. It needs a FCP anyway which can happen on the tracking issue (#50146). |
@ollie27 Ok, then please start the FCP on the issue. :) |
@GuillaumeGomez as you're the one proposing stabilization it would be better if you propose the FCP. Make sure you include an explanation as to why you think it should be stabilized and more specifically what it would be used for outside of |
Sure! |
Fixes #63222
cc @rust-lang/rustdoc
r? @ollie27