-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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: it should be possible to leave "Methods From Deref" empty, as was previously the default behaviour #83133
Comments
Are there any details on when precisely this changed, also? I've noticed that even though the auto-generated docs on |
Yes, it was changed intentionally in #80653 and mentioned in the release notes: https://github.com/rust-lang/rust/blob/master/RELEASES.md#rustdoc.
Vec derefs directly to slice - maybe the user crates you're talking about always deref to Vec? |
👍 I like this idea.
Hmm, I'm a little concerned the methods will be harder to find that way. We get a lot of complaints that the "Trait Implementations" section is hard to read because you have to click on the name of the trait to see what methods are available. |
Yeah, that makes sense. Honestly just showing |
Are you interested in making a PR for that? I think it would be as simple as moving rust/src/librustdoc/html/render/mod.rs Lines 1934 to 1940 in a5029ac
rust/src/librustdoc/html/render/mod.rs Lines 2001 to 2007 in a5029ac
|
Sure, I'll take a look at it tomorrow. |
Got busy with some other stuff, but I've now opened a PR that make those changes, which do accomplish what you thought they would. |
…order-shuffle, r=jyn514 List trait impls before deref methods in doc's sidebar This PR is acting directly on a suggestion made by `@jyn514` in rust-lang#83133. I've tested the changes locally, and can confirm that it does in fact properly achieve what he thought it would. This PR also in turn closes rust-lang#83133.
…order-shuffle, r=jyn514 List trait impls before deref methods in doc's sidebar This PR is acting directly on a suggestion made by ``@jyn514`` in rust-lang#83133. I've tested the changes locally, and can confirm that it does in fact properly achieve what he thought it would. This PR also in turn closes rust-lang#83133.
…order-shuffle, r=jyn514 List trait impls before deref methods in doc's sidebar This PR is acting directly on a suggestion made by ```@jyn514``` in rust-lang#83133. I've tested the changes locally, and can confirm that it does in fact properly achieve what he thought it would. This PR also in turn closes rust-lang#83133.
…order-shuffle, r=jyn514 List trait impls before deref methods in doc's sidebar This PR is acting directly on a suggestion made by ````@jyn514```` in rust-lang#83133. I've tested the changes locally, and can confirm that it does in fact properly achieve what he thought it would. This PR also in turn closes rust-lang#83133.
…order-shuffle, r=jyn514 List trait impls before deref methods in doc's sidebar This PR is acting directly on a suggestion made by `````@jyn514````` in rust-lang#83133. I've tested the changes locally, and can confirm that it does in fact properly achieve what he thought it would. This PR also in turn closes rust-lang#83133.
…order-shuffle, r=jyn514 List trait impls before deref methods in doc's sidebar This PR is acting directly on a suggestion made by ``````@jyn514`````` in rust-lang#83133. I've tested the changes locally, and can confirm that it does in fact properly achieve what he thought it would. This PR also in turn closes rust-lang#83133.
For example, I would much rather have the documentation for my crate Staticvec look as it did here, as opposed to pulling in the docs for every single slice method as it does now.
Edit: Some additional thoughts:
The text was updated successfully, but these errors were encountered: