-
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
rustdoc should mark #[deprecated] things as such #14493
Comments
👍 for sure |
The documentation now has colored bars indicating the stability status of a given API. There's more work to do though. Here's the issues I see:
|
cc @aturon, who apparently added the current stability displays in #15263. Looking at that PR, apparently the deprecation message actually is included, as the |
I completely agree with @kballard that there's more work to be done on the visual design here. My focus in #15263 was just getting the information available at all. Now that it's accessible and being rendered within rustdoc, it should be easy to iterate on the design. That said, it's nontrivial to balance discoverability with noisyness. Adding text like "experimental" for each item would add a lot of noise, now that |
cc #15345 |
@aturon For the trait code listing at the top, we should definitely add For other stability attributes, I we can definitely omit them from the code listings, and then I think we can get away with just having mouseover behavior. When I mouse over the function listing, perhaps the stability name could show up right-aligned with some visual treatment. FWIW, I've advocated in the past for having similar mouseover behavior that exposes a |
while #15468 is newer, it's already added to milestones and such, so I'm closing this as a duplicate of that. |
…=Veykril fix: insert whitespace between text and pound Because `text#`, `text"..."`, and `text'...'` are [reserved syntax since Rust 2021][guide]. Note that the latter two are already handled correctly. Fixes rust-lang#14487 [guide]: https://doc.rust-lang.org/edition-guide/rust-2021/reserving-syntax.html
For example, as of this writing, the
StrAllocating::to_owned
method is annotated with#[deprecated = "obsolete, use
to_string"]
, but http://doc.rust-lang.org/std/str/trait.StrAllocating.html#method.to_owned gives no indication of that.The text was updated successfully, but these errors were encountered: