Fixing rustDoc for LayoutError.

qinheping · Oct 10, 2024 · dd6dd70 · dd6dd70
1 parent 36a90d7
commit dd6dd70
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/core/src/alloc/layout.rs b/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")]