Remove methods under Implementors on trait pages #85970

jsha · 2021-06-03T17:36:54Z

On a trait page, the "Implementors" section currently lists all methods of each implementor. That duplicates the method definitions on the trait itself, and is usually not very useful. So the implementors are collapsed by default. This PR changes rustdoc to just not render them at all. Any documentation specific to an implementor can be found by clicking through to the implementor's page.

This moves the "portability" info inside the <summary> tags so it is still visible on trait pages (as originally implemented in #79201). That also means it will be visible on struct/enum pages when methods are collapsed.

Add #[doc(hidden)] to all implementations of Iterator::__iterator_get_unchecked that didn't already have it. Otherwise, due to #86145, the structs/enums with those implementations would generate documentation for them, and that documentation would have a broken link into the Iterator page. Those links were already "broken" but not detected by the link-checker, because they pointed to one of the Implementors on the Iterator page, which happened to have the right anchor name.

This reduces the Read trait's page size from 128kB to 68kB (uncompressed) and from 12,125 bytes to 9,989 bytes (gzipped
Demo:

https://hoffman-andrews.com/rust/remove-methods-implementors/std/string/struct.String.html#trait-implementations
https://hoffman-andrews.com/rust/remove-methods-implementors/std/io/trait.Read.html#implementors

r? @GuillaumeGomez

jsha · 2021-06-06T16:33:23Z

Ready for review.

@bors r? @GuillaumeGomez

GuillaumeGomez · 2021-06-06T18:16:17Z

CI disagree. ;)

GuillaumeGomez · 2021-06-06T18:21:21Z

src/librustdoc/html/render/mod.rs

-    let open_details = |close_tags: &mut String, is_collapsed: bool| {
+    let on_trait_page = matches!(*parent.kind, clean::ItemKind::TraitItem(_));
+    let has_impl_items = !(impl_items.is_empty() && default_impl_items.is_empty());
+    let toggled = !on_trait_page && has_impl_items;


Why do we want to check if we are on a trait page now? More like: why wasn't it an issue before?

jsha · 2021-06-06T19:14:15Z

If we're on a trait page, we aren't going to generate documentation below the heading, so there will be nothing to toggle.

jsha · 2021-06-07T19:20:42Z

CI flagged a real bug - some trait pages, like Error have in addition to the common Implementors section, and "Implementations" section - for instance impl dyn Error + 'static. We do want to keep the method documentation for those, because that's the only page such documentation will show up on. I'll work on fixing.

jsha · 2021-06-08T16:08:27Z

This is now rebased on top of #86128, and I've updated the demo. Turns out the refactoring from #86128 fixed the bug.

jsha · 2021-06-08T16:10:09Z

Actually, hold on, I see some more improvements to clarity I can make here.

jsha · 2021-06-08T20:19:54Z

Alright, ready again. Updated the PR description with some info about the latest changes:

This moves the "portability" info inside the <summary> tags so it is still visible on trait pages (as originally implemented in #79201). That also means it will be visible on struct/enum pages when methods are collapsed.

Add #[doc(hidden)] to all implementations of Iterator::__iterator_get_unchecked that didn't already have it. Otherwise, due to #86145, the structs/enums with those implementations would generate documentation for them, and that documentation would have a broken link into the Iterator page. Those links were already "broken" but not detected by the link-checker, because they pointed to one of the Implementors on the Iterator page, which happened to have the right anchor name.

…umeGomez Refactor: Extract render_summary from render_impl. This allows for a more readable straight-through logic in render_impl without need for a closure. I think this will make rust-lang#85970 a bit more of a straightforward change. This is a pure refactoring. I've verified that the output of `x.py doc library/std` is byte-for-byte identical. r? `@GuillaumeGomez`

bors · 2021-06-09T14:13:34Z

☔ The latest upstream changes (presumably #85975) made this pull request unmergeable. Please resolve the merge conflicts.

GuillaumeGomez · 2021-06-09T14:23:08Z

The current display is broken for me:

But otherwise looks like a great improvement!

jsha · 2021-06-16T17:41:38Z

Another question: why did you remove the tests (Especially trait-impl-items-links-and-anchors.rs)? Updating them would seem more logical no? As far as I can tell, you removed the methods from the implementors, not from the trait implementations, right?

Correct. I restored trait-impl-items-and-anchors, leaving the clauses that test for methods on "implementations" on struct/enum pages. I removed the clauses that test for methods on "implementors" on trait pages. I removed src/test/rustdoc/issue-19055.rs outright because the only clauses were testing for methods on "implementors."

jsha · 2021-06-16T17:59:10Z

Update: This PR simplified not just "Implementors," but also "Implementations on Foreign Types." We still want to keep the full details for "Implementations on Foreign Types," because those details won't be documented anywhere else. For instance it is really important to show an associated type in an "Implementation on Foreign Types." I'll update to fix.

jsha · 2021-06-16T22:07:49Z

Alright, I've restored the stuff under "Implementations on Foreign Types," and I've restored the test that was testing for that stuff. I've also updated the demo listed in the PR description. Ready for another look.

bors · 2021-06-17T01:18:24Z

☔ The latest upstream changes (presumably #86379) made this pull request unmergeable. Please resolve the merge conflicts.

These were hidden by default, and duplicated information already on the page anyhow. Also remove the "Auto-hide trait implementors of a trait" setting, which is not needed anymore.

This method on the Iterator trait is doc(hidden), and about half of implementations were doc(hidden). This adds the attribute to the remaining implementations.

That means it will be visible under "Implementors" on trait pages, and under "Implementations" on struct/enum pages, even when all methods are collapsed. Switch to a float layout for rightside elements.

This covers rendering of stability_since and the srclink across methods and trait implementations, so their DOM representation is consistent.

Also factor out outer_version and const_outer_version into render_rightside.

These were previously removed along with the details in the "Implementors" section of trait pages. But for "Implementations on Foreign Types," we need to include the details because they will not be documented anywhere else.

jsha · 2021-06-17T05:55:01Z

I merged master and squashed / rebased a few commits to simplify the history somewhat. I also backed out a somewhat unrelated change: typedefs and associated types don't currently have a srclink. In my refactoring I originally concluded that was an overight and fixed it, but this wound up being a big enough change I decided not to change unrelated things along with it.

Ready for review; demo is up to date.

GuillaumeGomez · 2021-06-17T08:21:54Z

I think we're good now. Thanks a lot!

@bors: r+

bors · 2021-06-17T08:21:56Z

📌 Commit bf81e13 has been approved by GuillaumeGomez

Rollup of 7 pull requests Successful merges: - rust-lang#85663 (Document Arc::from) - rust-lang#85802 (Rename IoSlice(Mut)::advance to advance_slice and add IoSlice(Mut)::advance) - rust-lang#85970 (Remove methods under Implementors on trait pages) - rust-lang#86340 (Use better error message for hard errors in CTFE) - rust-lang#86343 (Do not emit invalid suggestions on multiple mutable borrow errors) - rust-lang#86355 (Remove invalid suggestions for assoc consts on placeholder type error) - rust-lang#86389 (Make `sum()` and `product()` documentation hyperlinks refer to `Iterator` methods.) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

steffahn · 2021-07-11T13:57:01Z

Any documentation specific to an implementor can be found by clicking through to the implementor's page.

I don’t quite understand this. With the way things stand now, I can’t see any way to click through to get to the right place quickly. If I’m looking at an impl like
https://doc.rust-lang.org/nightly/std/ops/trait.BitAnd.html#impl-BitAnd%3C%26%27_%20BTreeSet%3CT%3E%3E
the easiest way to see the documentation of the method is literally by looking into the sourcecode via [src]. One click, and you see the documentation. Of course not rendered, but it’s probably enough. The only alternative is to click on BTreeSet and … scroll, scroll, scroll … start searching for BitAnd there, which is nontrivial. In this case then, the easiest way then would be to use your browser’s search.

I don’t think this is ergonomic at all, it desperately needs - at least - a proper link to the impl on the type’s documentation page.

By the way, either approach to finding the documentation still completely prohibits me from figuring out that this specific BitAnd implementation has extra documentation on the method in the first place. On stable, only undocumented trait methods are collapsed, so you immediately see that there is extra documentation. So IMO next to a link to the proper place where the impl is implemented, I also need to have an indicator (on the trait’s page) telling me if there are or aren’t additional documentation for some methods on the struct’s/enum’s page.

bjorn3 · 2021-07-26T12:32:38Z

^ I agree.

Pkgsrc changes: * Bump bootstrap kit version to 1.55.0. * Adjust patches as needed, some no longer apply (so removed) * Update checksum adjustments. * Avoid rust-llvm on SunOS * Optionally build docs * Remove reference to closed/old PR#54621 Upstream changes: Version 1.56.1 (2021-11-01) =========================== - New lints to detect the presence of bidirectional-override Unicode codepoints in the compiled source code ([CVE-2021-42574]) [CVE-2021-42574]: https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-42574 Version 1.56.0 (2021-10-21) ======================== Language -------- - [The 2021 Edition is now stable.][rust#88100] See [the edition guide][rust-2021-edition-guide] for more details. - [The pattern in `binding @ pattern` can now also introduce new bindings.] [rust#85305] - [Union field access is permitted in `const fn`.][rust#85769] [rust-2021-edition-guide]: https://doc.rust-lang.org/nightly/edition-guide/rust-2021/index.html Compiler -------- - [Upgrade to LLVM 13.][rust#87570] - [Support memory, address, and thread sanitizers on aarch64-unknown-freebsd.] [rust#88023] - [Allow specifying a deployment target version for all iOS targets][rust#87699] - [Warnings can be forced on with `--force-warn`.][rust#87472] This feature is primarily intended for usage by `cargo fix`, rather than end users. - [Promote `aarch64-apple-ios-sim` to Tier 2\*.][rust#87760] - [Add `powerpc-unknown-freebsd` at Tier 3\*.][rust#87370] - [Add `riscv32imc-esp-espidf` at Tier 3\*.][rust#87666] \* Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support. Libraries --------- - [Allow writing of incomplete UTF-8 sequences via stdout/stderr on Windows.] [rust#83342] The Windows console still requires valid Unicode, but this change allows splitting a UTF-8 character across multiple write calls. This allows, for instance, programs that just read and write data buffers (e.g. copying a file to stdout) without regard for Unicode or character boundaries. - [Prefer `AtomicU{64,128}` over Mutex for Instant backsliding protection.] [rust#83093] For this use case, atomics scale much better under contention. - [Implement `Extend<(A, B)>` for `(Extend<A>, Extend<B>)`][rust#85835] - [impl Default, Copy, Clone for std::io::Sink and std::io::Empty][rust#86744] - [`impl From<[(K, V); N]>` for all collections.][rust#84111] - [Remove `P: Unpin` bound on impl Future for Pin.][rust#81363] - [Treat invalid environment variable names as non-existent.][rust#86183] Previously, the environment functions would panic if given a variable name with an internal null character or equal sign (`=`). Now, these functions will just treat such names as non-existent variables, since the OS cannot represent the existence of a variable with such a name. Stabilised APIs --------------- - [`std::os::unix::fs::chroot`] - [`UnsafeCell::raw_get`] - [`BufWriter::into_parts`] - [`core::panic::{UnwindSafe, RefUnwindSafe, AssertUnwindSafe}`] These APIs were previously stable in `std`, but are now also available in `core`. - [`Vec::shrink_to`] - [`String::shrink_to`] - [`OsString::shrink_to`] - [`PathBuf::shrink_to`] - [`BinaryHeap::shrink_to`] - [`VecDeque::shrink_to`] - [`HashMap::shrink_to`] - [`HashSet::shrink_to`] These APIs are now usable in const contexts: - [`std::mem::transmute`] - [`[T]::first`][`slice::first`] - [`[T]::split_first`][`slice::split_first`] - [`[T]::last`][`slice::last`] - [`[T]::split_last`][`slice::split_last`] Cargo ----- - [Cargo supports specifying a minimum supported Rust version in Cargo.toml.] [`rust-version`] This has no effect at present on dependency version selection. We encourage crates to specify their minimum supported Rust version, and we encourage CI systems that support Rust code to include a crate's specified minimum version in the text matrix for that crate by default. Compatibility notes ------------------- - [Update to new argument parsing rules on Windows.][rust#87580] This adjusts Rust's standard library to match the behavior of the standard libraries for C/C++. The rules have changed slightly over time, and this PR brings us to the latest set of rules (changed in 2008). - [Disallow the aapcs calling convention on aarch64][rust#88399] This was already not supported by LLVM; this change surfaces this lack of support with a better error message. - [Make `SEMICOLON_IN_EXPRESSIONS_FROM_MACROS` warn by default][rust#87385] - [Warn when an escaped newline skips multiple lines.][rust#87671] - [Calls to `libc::getpid` / `std::process::id` from `Command::pre_exec` may return different values on glibc <= 2.24.][rust#81825] Rust now invokes the `clone3` system call directly, when available, to use new functionality available via that system call. Older versions of glibc cache the result of `getpid`, and only update that cache when calling glibc's clone/fork functions, so a direct system call bypasses that cache update. glibc 2.25 and newer no longer cache `getpid` for exactly this reason. Internal changes ---------------- These changes provide no direct user facing benefits, but represent significant improvements to the internals and overall performance of rustc and related tools. - [LLVM is compiled with PGO in published x86_64-unknown-linux-gnu artifacts.] [rust#88069] This improves the performance of most Rust builds. - [Unify representation of macros in internal data structures.][rust#88019] This change fixes a host of bugs with the handling of macros by the compiler, as well as rustdoc. [`std::os::unix::fs::chroot`]: https://doc.rust-lang.org/stable/std/os/unix/fs/fn.chroot.html [`Iterator::intersperse`]: https://doc.rust-lang.org/stable/std/iter/trait.Iterator.html#method.intersperse [`Iterator::intersperse_with`]: https://doc.rust-lang.org/stable/std/iter/trait.Iterator.html#method.intersperse [`UnsafeCell::raw_get`]: https://doc.rust-lang.org/stable/std/cell/struct.UnsafeCell.html#method.raw_get [`BufWriter::into_parts`]: https://doc.rust-lang.org/stable/std/io/struct.BufWriter.html#method.into_parts [`core::panic::{UnwindSafe, RefUnwindSafe, AssertUnwindSafe}`]: rust-lang/rust#84662 [`Vec::shrink_to`]: https://doc.rust-lang.org/stable/std/vec/struct.Vec.html#method.shrink_to [`String::shrink_to`]: https://doc.rust-lang.org/stable/std/string/struct.String.html#method.shrink_to [`OsString::shrink_to`]: https://doc.rust-lang.org/stable/std/ffi/struct.OsString.html#method.shrink_to [`PathBuf::shrink_to`]: https://doc.rust-lang.org/stable/std/path/struct.PathBuf.html#method.shrink_to [`BinaryHeap::shrink_to`]: https://doc.rust-lang.org/stable/std/collections/struct.BinaryHeap.html#method.shrink_to [`VecDeque::shrink_to`]: https://doc.rust-lang.org/stable/std/collections/struct.VecDeque.html#method.shrink_to [`HashMap::shrink_to`]: https://doc.rust-lang.org/stable/std/collections/hash_map/struct.HashMap.html#method.shrink_to [`HashSet::shrink_to`]: https://doc.rust-lang.org/stable/std/collections/hash_set/struct.HashSet.html#method.shrink_to [`std::mem::transmute`]: https://doc.rust-lang.org/stable/std/mem/fn.transmute.html [`slice::first`]: https://doc.rust-lang.org/stable/std/primitive.slice.html#method.first [`slice::split_first`]: https://doc.rust-lang.org/stable/std/primitive.slice.html#method.split_first [`slice::last`]: https://doc.rust-lang.org/stable/std/primitive.slice.html#method.last [`slice::split_last`]: https://doc.rust-lang.org/stable/std/primitive.slice.html#method.split_last [`rust-version`]: https://doc.rust-lang.org/nightly/cargo/reference/manifest.html#the-rust-version-field [rust#87671]: rust-lang/rust#87671 [rust#86183]: rust-lang/rust#86183 [rust#87385]: rust-lang/rust#87385 [rust#88100]: rust-lang/rust#88100 [rust#86860]: rust-lang/rust#86860 [rust#84039]: rust-lang/rust#84039 [rust#86492]: rust-lang/rust#86492 [rust#88363]: rust-lang/rust#88363 [rust#85305]: rust-lang/rust#85305 [rust#87832]: rust-lang/rust#87832 [rust#88069]: rust-lang/rust#88069 [rust#87472]: rust-lang/rust#87472 [rust#87699]: rust-lang/rust#87699 [rust#87570]: rust-lang/rust#87570 [rust#88023]: rust-lang/rust#88023 [rust#87760]: rust-lang/rust#87760 [rust#87370]: rust-lang/rust#87370 [rust#87580]: rust-lang/rust#87580 [rust#83342]: rust-lang/rust#83342 [rust#83093]: rust-lang/rust#83093 [rust#88177]: rust-lang/rust#88177 [rust#88548]: rust-lang/rust#88548 [rust#88551]: rust-lang/rust#88551 [rust#88299]: rust-lang/rust#88299 [rust#88220]: rust-lang/rust#88220 [rust#85835]: rust-lang/rust#85835 [rust#86879]: rust-lang/rust#86879 [rust#86744]: rust-lang/rust#86744 [rust#84662]: rust-lang/rust#84662 [rust#86593]: rust-lang/rust#86593 [rust#81050]: rust-lang/rust#81050 [rust#81363]: rust-lang/rust#81363 [rust#84111]: rust-lang/rust#84111 [rust#85769]: rust-lang/rust#85769 (comment) [rust#88490]: rust-lang/rust#88490 [rust#88269]: rust-lang/rust#88269 [rust#84176]: rust-lang/rust#84176 [rust#88399]: rust-lang/rust#88399 [rust#88227]: rust-lang/rust#88227 [rust#88200]: rust-lang/rust#88200 [rust#82776]: rust-lang/rust#82776 [rust#88077]: rust-lang/rust#88077 [rust#87728]: rust-lang/rust#87728 [rust#87050]: rust-lang/rust#87050 [rust#87619]: rust-lang/rust#87619 [rust#81825]: rust-lang/rust#81825 (comment) [rust#88019]: rust-lang/rust#88019 [rust#87666]: rust-lang/rust#87666 Version 1.55.0 (2021-09-09) ============================ Language -------- - [You can now write open "from" range patterns (`X..`), which will start at `X` and will end at the maximum value of the integer.][83918] - [You can now explicitly import the prelude of different editions through `std::prelude` (e.g. `use std::prelude::rust_2021::*;`).][86294] Compiler -------- - [Added tier 3\* support for `powerpc64le-unknown-freebsd`.][83572] \* Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support. Libraries --------- - [Updated std's float parsing to use the Eisel-Lemire algorithm.][86761] These improvements should in general provide faster string parsing of floats, no longer reject certain valid floating point values, and reduce the produced code size for non-stripped artifacts. - [`string::Drain` now implements `AsRef<str>` and `AsRef<[u8]>`.][86858] Stabilised APIs --------------- - [`Bound::cloned`] - [`Drain::as_str`] - [`IntoInnerError::into_error`] - [`IntoInnerError::into_parts`] - [`MaybeUninit::assume_init_mut`] - [`MaybeUninit::assume_init_ref`] - [`MaybeUninit::write`] - [`array::map`] - [`ops::ControlFlow`] - [`x86::_bittest`] - [`x86::_bittestandcomplement`] - [`x86::_bittestandreset`] - [`x86::_bittestandset`] - [`x86_64::_bittest64`] - [`x86_64::_bittestandcomplement64`] - [`x86_64::_bittestandreset64`] - [`x86_64::_bittestandset64`] The following previously stable functions are now `const`. - [`str::from_utf8_unchecked`] Cargo ----- - [Cargo will now deduplicate compiler diagnostics to the terminal when invoking rustc in parallel such as when using `cargo test`.][cargo/9675] - [The package definition in `cargo metadata` now includes the `"default_run"` field from the manifest.][cargo/9550] - [Added `cargo d` as an alias for `cargo doc`.][cargo/9680] - [Added `{lib}` as formatting option for `cargo tree` to print the `"lib_name"` of packages.][cargo/9663] Rustdoc ------- - [Added "Go to item on exact match" search option.][85876] - [The "Implementors" section on traits no longer shows redundant method definitions.][85970] - [Trait implementations are toggled open by default.][86260] This should make the implementations more searchable by tools like `CTRL+F` in your browser. - [Intra-doc links should now correctly resolve associated items (e.g. methods) through type aliases.][86334] - [Traits which are marked with `#[doc(hidden)]` will no longer appear in the "Trait Implementations" section.][86513] Compatibility Notes ------------------- - [std functions that return an `io::Error` will no longer use the `ErrorKind::Other` variant.][85746] This is to better reflect that these kinds of errors could be categorised [into newer more specific `ErrorKind` variants][79965], and that they do not represent a user error. - [Using environment variable names with `process::Command` on Windows now behaves as expected.][85270] Previously using envionment variables with `Command` would cause them to be ASCII-uppercased. - [Rustdoc will now warn on using rustdoc lints that aren't prefixed with `rustdoc::`][86849] [86849]: rust-lang/rust#86849 [86513]: rust-lang/rust#86513 [86334]: rust-lang/rust#86334 [86260]: rust-lang/rust#86260 [85970]: rust-lang/rust#85970 [85876]: rust-lang/rust#85876 [83572]: rust-lang/rust#83572 [86294]: rust-lang/rust#86294 [86858]: rust-lang/rust#86858 [86761]: rust-lang/rust#86761 [85769]: rust-lang/rust#85769 [85746]: rust-lang/rust#85746 [85305]: rust-lang/rust#85305 [85270]: rust-lang/rust#85270 [84111]: rust-lang/rust#84111 [83918]: rust-lang/rust#83918 [79965]: rust-lang/rust#79965 [87370]: rust-lang/rust#87370 [87298]: rust-lang/rust#87298 [cargo/9663]: rust-lang/cargo#9663 [cargo/9675]: rust-lang/cargo#9675 [cargo/9550]: rust-lang/cargo#9550 [cargo/9680]: rust-lang/cargo#9680 [cargo/9663]: rust-lang/cargo#9663 [`array::map`]: https://doc.rust-lang.org/stable/std/primitive.array.html#method.map [`Bound::cloned`]: https://doc.rust-lang.org/stable/std/ops/enum.Bound.html#method.cloned [`Drain::as_str`]: https://doc.rust-lang.org/stable/std/string/struct.Drain.html#method.as_str [`IntoInnerError::into_error`]: https://doc.rust-lang.org/stable/std/io/struct.IntoInnerError.html#method.into_error [`IntoInnerError::into_parts`]: https://doc.rust-lang.org/stable/std/io/struct.IntoInnerError.html#method.into_parts [`MaybeUninit::assume_init_mut`]: https://doc.rust-lang.org/stable/std/mem/union.MaybeUninit.html#method.assume_init_mut [`MaybeUninit::assume_init_ref`]: https://doc.rust-lang.org/stable/std/mem/union.MaybeUninit.html#method.assume_init_ref [`MaybeUninit::write`]: https://doc.rust-lang.org/stable/std/mem/union.MaybeUninit.html#method.write [`Seek::rewind`]: https://doc.rust-lang.org/stable/std/io/trait.Seek.html#method.rewind [`ops::ControlFlow`]: https://doc.rust-lang.org/stable/std/ops/enum.ControlFlow.html [`str::from_utf8_unchecked`]: https://doc.rust-lang.org/stable/std/str/fn.from_utf8_unchecked.html [`x86::_bittest`]: https://doc.rust-lang.org/stable/core/arch/x86/fn._bittest.html [`x86::_bittestandcomplement`]: https://doc.rust-lang.org/stable/core/arch/x86/fn._bittestandcomplement.html [`x86::_bittestandreset`]: https://doc.rust-lang.org/stable/core/arch/x86/fn._bittestandreset.html [`x86::_bittestandset`]: https://doc.rust-lang.org/stable/core/arch/x86/fn._bittestandset.html [`x86_64::_bittest64`]: https://doc.rust-lang.org/stable/core/arch/x86_64/fn._bittest64.html [`x86_64::_bittestandcomplement64`]: https://doc.rust-lang.org/stable/core/arch/x86_64/fn._bittestandcomplement64.html [`x86_64::_bittestandreset64`]: https://doc.rust-lang.org/stable/core/arch/x86_64/fn._bittestandreset64.html [`x86_64::_bittestandset64`]: https://doc.rust-lang.org/stable/core/arch/x86_64/fn._bittestandset64.html

rust-highfive assigned GuillaumeGomez Jun 3, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 3, 2021

This comment has been minimized.

Sign in to view

jsha force-pushed the remove-methods-implementors branch from 3fa2da2 to 0991f08 Compare June 6, 2021 16:30

jsha changed the title ~~Remove duplicate methods under trait implementors~~ Remove methods under Implementors on trait pages Jun 6, 2021

jsha marked this pull request as ready for review June 6, 2021 16:33

This comment has been minimized.

Sign in to view

GuillaumeGomez reviewed Jun 6, 2021

View reviewed changes

jsha mentioned this pull request Jun 8, 2021

Refactor: Extract render_summary from render_impl. #86128

Merged

jsha force-pushed the remove-methods-implementors branch from 0991f08 to 9e8a54a Compare June 8, 2021 05:05

jsha added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-ui Area: rustdoc UI (generated HTML) labels Jun 8, 2021

jsha marked this pull request as draft June 8, 2021 16:10

jsha mentioned this pull request Jun 8, 2021

linkchecker misreports target of broken link fragment #86144

Closed

This comment has been minimized.

Sign in to view

jsha marked this pull request as ready for review June 8, 2021 20:19

jsha force-pushed the remove-methods-implementors branch from c1f9ae1 to 5c7306d Compare June 12, 2021 05:18

This comment has been minimized.

Sign in to view

jsha force-pushed the remove-methods-implementors branch from 5c7306d to 8cb3eff Compare June 12, 2021 06:27

jsha added 8 commits June 16, 2021 22:08

Remove methods under Implementors on trait pages

ce64729

These were hidden by default, and duplicated information already on the page anyhow. Also remove the "Auto-hide trait implementors of a trait" setting, which is not needed anymore.

Use render_impl_summary when rendering traits.

bff4f07

Add doc(hidden) to all __iterator_get_unchecked

910c7fa

This method on the Iterator trait is doc(hidden), and about half of implementations were doc(hidden). This adds the attribute to the remaining implementations.

Make portability part of the summary.

593d6d1

That means it will be visible under "Implementors" on trait pages, and under "Implementations" on struct/enum pages, even when all methods are collapsed. Switch to a float layout for rightside elements.

Factor out render_rightside

5de1391

This covers rendering of stability_since and the srclink across methods and trait implementations, so their DOM representation is consistent.

Move anchor earlier in the DOM for easier layout

c4fa6d5

Fix target highlighting in rustdoc.

2ac5c17

Also factor out outer_version and const_outer_version into render_rightside.

Restore details for Impls on Foreign Types

bf81e13

These were previously removed along with the details in the "Implementors" section of trait pages. But for "Implementations on Foreign Types," we need to include the details because they will not be documented anywhere else.

jsha force-pushed the remove-methods-implementors branch from 0f111b4 to bf81e13 Compare June 17, 2021 05:53

GuillaumeGomez approved these changes Jun 17, 2021

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 17, 2021

JohnTitor mentioned this pull request Jun 17, 2021

Rollup of 7 pull requests #86399

Merged

bors merged commit 9521da7 into rust-lang:master Jun 17, 2021

rustbot added this to the 1.55.0 milestone Jun 17, 2021

This was referenced Jun 21, 2021

rustdoc: remove redundant toggles for "undocumented items" #84326

Open

rustdoc: trait implementors don't have assoc. types shown #86631

Closed

JohnTitor mentioned this pull request Jun 30, 2021

Upgrade normalize.css to v8.0.1 #86725

Merged

jyn514 added the relnotes Marks issues that should be documented in the release notes of the next release. label Jul 30, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove methods under Implementors on trait pages #85970

Remove methods under Implementors on trait pages #85970

jsha commented Jun 3, 2021 •

edited

Loading

This comment has been minimized.

jsha commented Jun 6, 2021

This comment has been minimized.

GuillaumeGomez commented Jun 6, 2021

GuillaumeGomez Jun 6, 2021

jsha commented Jun 6, 2021 via email

jsha commented Jun 7, 2021

jsha commented Jun 8, 2021

jsha commented Jun 8, 2021

This comment has been minimized.

This comment has been minimized.

jsha commented Jun 8, 2021 •

edited

Loading

bors commented Jun 9, 2021

GuillaumeGomez commented Jun 9, 2021

This comment has been minimized.

jsha commented Jun 16, 2021

jsha commented Jun 16, 2021

jsha commented Jun 16, 2021

bors commented Jun 17, 2021

jsha commented Jun 17, 2021

GuillaumeGomez commented Jun 17, 2021

bors commented Jun 17, 2021

steffahn commented Jul 11, 2021

bjorn3 commented Jul 26, 2021

Remove methods under Implementors on trait pages #85970

Remove methods under Implementors on trait pages #85970

Conversation

jsha commented Jun 3, 2021 • edited Loading

This comment has been minimized.

jsha commented Jun 6, 2021

This comment has been minimized.

GuillaumeGomez commented Jun 6, 2021

GuillaumeGomez Jun 6, 2021

Choose a reason for hiding this comment

jsha commented Jun 6, 2021 via email

jsha commented Jun 7, 2021

jsha commented Jun 8, 2021

jsha commented Jun 8, 2021

This comment has been minimized.

This comment has been minimized.

jsha commented Jun 8, 2021 • edited Loading

bors commented Jun 9, 2021

GuillaumeGomez commented Jun 9, 2021

This comment has been minimized.

jsha commented Jun 16, 2021

jsha commented Jun 16, 2021

jsha commented Jun 16, 2021

bors commented Jun 17, 2021

jsha commented Jun 17, 2021

GuillaumeGomez commented Jun 17, 2021

bors commented Jun 17, 2021

steffahn commented Jul 11, 2021

bjorn3 commented Jul 26, 2021

jsha commented Jun 3, 2021 •

edited

Loading

jsha commented Jun 8, 2021 •

edited

Loading