Sort sidebar implementations on foreign types with natural compare

Author: chenyukang

src/librustdoc/html/render/sidebar.rs

@@ -12,6 +12,7 @@ use crate::clean;
 use crate::formats::Impl;
 use crate::formats::item_type::ItemType;
 use crate::html::markdown::{IdMap, MarkdownWithToc};
+use crate::html::render::print_item::compare_names;
 
 #[derive(Clone, Copy)]
 pub(crate) enum ModuleLike {
@@ -297,7 +298,7 @@ fn sidebar_trait<'a>(
                 .filter_map(|i| super::extract_for_impl_name(&i.impl_item, cx))
                 .map(|(name, id)| Link::new(id, name)),
         );
-        foreign_impls.sort();
+        foreign_impls.sort_by(|a, b| compare_names(&a.name, &b.name));
     }
 
     blocks.extend(

tests/rustdoc-gui/sidebar-foreign-impl-sort.goml

@@ -0,0 +1,15 @@
+// Checks sidebar resizing close the Settings popover
+go-to: "file://" + |DOC_PATH| + "/test_docs/SidebarSort/trait.Sort.html#foreign-impls"
+
+// Check that the sidebar contains the expected foreign implementations
+assert-text: (".sidebar-elems section ul > li:nth-child(1)", "&'a str")
+assert-text: (".sidebar-elems section ul > li:nth-child(2)", "AtomicBool")
+assert-text: (".sidebar-elems section ul > li:nth-child(3)", "AtomicU8")
+assert-text: (".sidebar-elems section ul > li:nth-child(4)", "AtomicU16")
+assert-text: (".sidebar-elems section ul > li:nth-child(5)", "AtomicU32")
+assert-text: (".sidebar-elems section ul > li:nth-child(6)", "Cell<u8>")
+assert-text: (".sidebar-elems section ul > li:nth-child(7)", "Cell<u16>")
+assert-text: (".sidebar-elems section ul > li:nth-child(8)", "u8")
+assert-text: (".sidebar-elems section ul > li:nth-child(9)", "u16")
+assert-text: (".sidebar-elems section ul > li:nth-child(10)", "u32")
+assert-text: (".sidebar-elems section ul > li:nth-child(11)", "usize")

tests/rustdoc-gui/src/test_docs/lib.rs

@@ -1,7 +1,6 @@
 //! The point of this crate is to be able to have enough different "kinds" of
 //! documentation generated so we can test each different features.
-#![doc(html_playground_url="https://play.rust-lang.org/")]
-
+#![doc(html_playground_url = "https://play.rust-lang.org/")]
 #![crate_name = "test_docs"]
 #![allow(internal_features)]
 #![feature(rustdoc_internals)]
@@ -343,18 +342,17 @@ pub trait EmptyTrait1 {}
 pub trait EmptyTrait2 {}
 pub trait EmptyTrait3 {}
 
-pub struct HasEmptyTraits{}
+pub struct HasEmptyTraits {}
 
 impl EmptyTrait1 for HasEmptyTraits {}
 impl EmptyTrait2 for HasEmptyTraits {}
 #[doc(cfg(feature = "some-feature"))]
 impl EmptyTrait3 for HasEmptyTraits {}
 
 mod macros;
-pub use macros::*;
-
 #[doc(alias = "AliasForTheStdReexport")]
 pub use ::std as TheStdReexport;
+pub use macros::*;
 
 pub mod details {
     /// We check the appearance of the `<details>`/`<summary>` in here.
@@ -406,19 +404,22 @@ pub mod doc_block_table {
             println!();
         }
     }
-
 }
 
 pub struct NotableStructWithLongName<R>(R);
 
 impl<R: std::io::Read> NotableStructWithLongName<R> {
-    pub fn create_an_iterator_from_read(r: R) -> NotableStructWithLongName<R> { Self(r) }
+    pub fn create_an_iterator_from_read(r: R) -> NotableStructWithLongName<R> {
+        Self(r)
+    }
 }
 
 impl<R: std::io::Read> std::iter::Iterator for NotableStructWithLongName<R> {
     type Item = ();
 
-    fn next(&mut self) -> Option<Self::Item> { () }
+    fn next(&mut self) -> Option<Self::Item> {
+        ()
+    }
 }
 
 pub trait TraitWithNoDocblocks {
@@ -527,7 +528,6 @@ pub mod search_results {
     macro_rules! foo {
         () => {};
     }
-
 }
 
 pub mod fields {
@@ -540,14 +540,8 @@ pub mod fields {
         pub b: u32,
     }
     pub enum Enum {
-        A {
-            a: u8,
-            b: u32,
-        },
-        B {
-            a: u8,
-            b: u32,
-        },
+        A { a: u8, b: u32 },
+        B { a: u8, b: u32 },
     }
 }
 
@@ -713,3 +707,21 @@ pub trait ItemsTrait {
     /// blablala
     fn bar();
 }
+
+pub mod SidebarSort {
+    use std::cell::Cell;
+    use std::sync::atomic::*;
+    pub trait Sort {}
+
+    impl Sort for u32 {}
+    impl Sort for u8 {}
+    impl Sort for u16 {}
+    impl Sort for usize {}
+    impl Sort for AtomicU32 {}
+    impl Sort for AtomicU16 {}
+    impl Sort for AtomicU8 {}
+    impl Sort for AtomicBool {}
+    impl Sort for Cell<u16> {}
+    impl Sort for Cell<u8> {}
+    impl<'a> Sort for &'a str {}
+}