From 5667e7eb5115e7fdea5478c4788bdab9e5a28b2c Mon Sep 17 00:00:00 2001
From: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
Date: Thu, 15 Apr 2021 22:23:15 +0200
Subject: [PATCH] Add docstring to ui.with_layout

---
 egui/src/ui.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/egui/src/ui.rs b/egui/src/ui.rs
index 7dc436b7..1b0f6439 100644
--- a/egui/src/ui.rs
+++ b/egui/src/ui.rs
@@ -1397,6 +1397,10 @@ impl Ui {
         )
     }
 
+    /// The new layout will take up all available space.
+    ///
+    /// Consider using [`Self::allocate_ui_with_layout`] instead,
+    /// or the helpers [`Self::horizontal]`, [`Self::vertical`], etc.
     pub fn with_layout<R>(
         &mut self,
         layout: Layout,