From 13769c281afc35edd29fb080e3c17183b2387d01 Mon Sep 17 00:00:00 2001
From: David Judge <dbiro97@gmail.com>
Date: Mon, 22 May 2023 19:33:23 +0200
Subject: [PATCH] Mention `store` in `TextEditState` doc comment (#2988)

Closes #2950
---
 crates/egui/src/widgets/text_edit/state.rs | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/crates/egui/src/widgets/text_edit/state.rs b/crates/egui/src/widgets/text_edit/state.rs
index 8a638092..b4c40861 100644
--- a/crates/egui/src/widgets/text_edit/state.rs
+++ b/crates/egui/src/widgets/text_edit/state.rs
@@ -9,6 +9,27 @@ use super::{CCursorRange, CursorRange};
 type Undoer = crate::util::undoer::Undoer<(CCursorRange, String)>;
 
 /// The text edit state stored between frames.
+///
+/// Attention: You also need to `store` the updated state.
+/// ```
+/// # use egui::text::CCursor;
+/// # use egui::text_edit::{CCursorRange, TextEditOutput};
+/// # use egui::TextEdit;
+/// # egui::__run_test_ui(|ui| {
+/// # let mut text = String::new();
+/// let mut output = TextEdit::singleline(&mut text).show(ui);
+///
+/// // Create a new selection range
+/// let min = CCursor::new(0);
+/// let max = CCursor::new(0);
+/// let new_range = CCursorRange::two(min, max);
+///
+/// // Update the state
+/// output.state.set_ccursor_range(Some(new_range));
+/// // Store the updated state
+/// output.state.store(ui.ctx(), output.response.id);
+/// # });
+/// ```
 #[derive(Clone, Default)]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[cfg_attr(feature = "serde", serde(default))]