From 89a645ee1190edf426faa8cacc2fb12d5b30d9c9 Mon Sep 17 00:00:00 2001 From: Max Brunsfeld Date: Thu, 4 Aug 2022 11:25:09 -0700 Subject: [PATCH] Add docs to some EditorTestContext methods that use marked text --- crates/editor/src/test.rs | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/crates/editor/src/test.rs b/crates/editor/src/test.rs index 30f336c68e462ebd5617037d60e4091ec930a919..5f6528db1c32b816694859c0e5e13b028207f23a 100644 --- a/crates/editor/src/test.rs +++ b/crates/editor/src/test.rs @@ -183,7 +183,7 @@ impl<'a> EditorTestContext<'a> { } } - pub fn ranges(&self, marked_text: &str) -> Vec> { + fn ranges(&self, marked_text: &str) -> Vec> { let (unmarked_text, ranges) = marked_text_ranges(marked_text, false); assert_eq!(self.buffer_text(), unmarked_text); ranges @@ -204,6 +204,11 @@ impl<'a> EditorTestContext<'a> { snapshot.anchor_before(ranges[0].start)..snapshot.anchor_after(ranges[0].end) } + /// Change the editor's text and selections using a string containing + /// embedded range markers that represent the ranges and directions of + /// each selection. + /// + /// See the `util::test::marked_text_ranges` function for more information. pub fn set_state(&mut self, marked_text: &str) { let (unmarked_text, selection_ranges) = marked_text_ranges(marked_text, true); self.editor.update(self.cx, |editor, cx| { @@ -214,6 +219,10 @@ impl<'a> EditorTestContext<'a> { }) } + /// Make an assertion about the editor's text and the ranges and directions + /// of its selections using a string containing embedded range markers. + /// + /// See the `util::test::marked_text_ranges` function for more information. pub fn assert_editor_state(&mut self, marked_text: &str) { let (unmarked_text, expected_selections) = marked_text_ranges(marked_text, true); let buffer_text = self.buffer_text();