about summary refs log tree commit diff
path: root/library/core/src/alloc/layout.rs
diff options
context:
space:
mode:
authorJohnathan W <12262567+j7nw4r@users.noreply.github.com>2024-10-10 16:11:30 -0400
committerJohnathan W <12262567+j7nw4r@users.noreply.github.com>2024-10-10 16:18:56 -0400
commit8b754fbb4f4fa05f0e7550c8a3aa4c9e8bd95e11 (patch)
treeeb338dc60c49fad9d296f6f3512561692e7a70f8 /library/core/src/alloc/layout.rs
parent8d94e06ec9758b5c03ea77bb5dab22a1a76bc261 (diff)
downloadrust-8b754fbb4f4fa05f0e7550c8a3aa4c9e8bd95e11.tar.gz
rust-8b754fbb4f4fa05f0e7550c8a3aa4c9e8bd95e11.zip
Fixing rustDoc for LayoutError.
Diffstat (limited to 'library/core/src/alloc/layout.rs')
-rw-r--r--library/core/src/alloc/layout.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/library/core/src/alloc/layout.rs b/library/core/src/alloc/layout.rs
index 107d82267e5..fca32b9d3c5 100644
--- 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")]