Auto merge of rust-lang#131512 - j7nw4r:master, r=jhpratt

Fixing rustDoc for LayoutError. I started reading the the std lib from start to finish and noticed that this rustdoc comment wasn't correct.
rust-lang-ci · Oct 11, 2024 · 44adce9 · 44adce9
2 parents 0321e73 + 8b754fb
commit 44adce9
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/library/core/src/alloc/layout.rs b/library/core/src/alloc/layout.rs
@@ -540,7 +540,8 @@ impl Layout {
 )]
 pub type LayoutErr = LayoutError;
 
-/// The parameters given to `Layout::from_size_align`
+/// The `LayoutError` is returned when the parameters given
+/// to `Layout::from_size_align`
 /// or some other `Layout` constructor
 /// do not satisfy its documented constraints.
 #[stable(feature = "alloc_layout_error", since = "1.50.0")]