Use suggestions

sharktide · sharktide · commit 2852ee202833 · 2025-08-11T16:15:44.000-04:00
diff --git a/Doc/whatsnew/3.15.rst b/Doc/whatsnew/3.15.rst
@@ -70,8 +70,6 @@ Summary --- release highlights
 New features
 ============
 
-.. tkinter.Text is not currently documented - being tracked in :gh:``135658``
-
 .. _whatsnew315-sampling-profiler:
 
 High frequency statistical sampling profiler
@@ -358,13 +356,13 @@ tarfile
 tkinter
 -------
 
-* The ``tkinter.Text.search`` method now supports two additional
-  arguments: ``nolinestop`` which allows the search to
+* The :meth:`!tkinter.Text.search` method now supports two additional
+  arguments: *nolinestop* which allows the search to
   continue across line boundaries;
-  and ``strictlimits`` which restricts the search to within the specified range.
+  and *strictlimits* which restricts the search to within the specified range.
   (Contributed by Rihaan Meher in :gh:`130848`)
 
-* A new method ``tkinter.Text.search_all`` has been introduced.
+* A new method :meth:`!tkinter.Text.search_all` has been introduced.
   This method allows for searching for all matches of a pattern
   using Tcl's ``-all`` and ``-overlap`` options.
   (Contributed by Rihaan Meher in :gh:`130848`)
diff --git a/Lib/test/test_tkinter/test_text.py b/Lib/test/test_tkinter/test_text.py
@@ -27,11 +27,16 @@ def test_debug(self):
     def test_search(self):
         text = self.text
 
+        # pattern and index are obligatory arguments.
         self.assertRaises(tkinter.TclError, text.search, None, '1.0')
         self.assertRaises(tkinter.TclError, text.search, 'a', None)
         self.assertRaises(tkinter.TclError, text.search, None, None)
+
+        # Invalid text index.
         self.assertRaises(tkinter.TclError, text.search, '', 0)
 
+        # Check if we are getting the indices as strings -- you are likely
+        # to get Tcl_Obj under Tk 8.5 if Tkinter doesn't convert it.
         text.insert('1.0', 'hi-test')
         self.assertEqual(text.search('-test', '1.0', 'end'), '1.2')
         self.assertEqual(text.search('test', '1.0', 'end'), '1.3')
@@ -45,19 +50,37 @@ def test_search(self):
         result = text.search('line', '1.0', 'end', nolinestop=True, regexp=True)
         self.assertEqual(result, '2.8')
 
-        all_res = text.search_all('test', '1.0', 'end')
-        self.assertIsInstance(all_res, tuple)
-        self.assertGreaterEqual(len(all_res), 2)
-        self.assertEqual(str(all_res[0]), '1.10')
-        self.assertEqual(str(all_res[1]), '1.31')
+        strict_res = text.search('test', '1.0', '1.20', strictlimits=True)
+        self.assertEqual(strict_res, '1.10')
 
+    def test_search_all(self):
+        text = self.text
+        text.insert('1.0',
+            'ababa ababa\n'
+            'ababababa\n'
+            'aba aba')
 
-        overlap_res = text.search_all('test', '1.0', 'end', overlap=True)
+        all_res = text.search_all('aba', '1.0', 'end')
+        all_res_strs = [str(i) for i in all_res]
+        self.assertIsInstance(all_res, tuple)
+        self.assertGreaterEqual(len(all_res), 3)
+        self.assertEqual(str(all_res[0]), '1.0')
+        self.assertEqual(str(all_res[1]), '1.6')
+
+        overlap_res = text.search_all('aba', '1.0', 'end', overlap=True)
+        overlap_res_strs = [str(i) for i in overlap_res]
         self.assertIsInstance(overlap_res, tuple)
-        self.assertGreaterEqual(len(overlap_res), len(all_res))
+        self.assertGreater(len(overlap_res), len(all_res))
 
-        strict_res = text.search('test', '1.0', '1.20', strictlimits=True)
-        self.assertEqual(strict_res, '1.10')
+        # Check that overlap actually finds overlapping matches
+        self.assertIn('2.0', overlap_res_strs)
+        self.assertIn('2.2', overlap_res_strs)
+        self.assertIn('2.4', overlap_res_strs)
+        self.assertNotIn('2.2', all_res_strs)
+
+        # Ensure all results are valid text indices
+        for i in overlap_res:
+            self.assertRegex(str(i), r'^\d+\.\d+$')
 
     def test_count(self):
         text = self.text
diff --git a/Lib/tkinter/__init__.py b/Lib/tkinter/__init__.py
@@ -4067,7 +4067,7 @@ def search_all(self, pattern, index, stopindex=None, *,
             elide=None, nolinestop=None, overlap=None,
             strictlimits=None):
         """Search all occurrences of PATTERN from INDEX to STOPINDEX.
-        Return a list of indices where matches begin."""
+        Return a tuple of indices where matches begin."""
         args = [self._w, 'search', '-all']
         if forwards: args.append('-forwards')
         if backwards: args.append('-backwards')
diff --git a/Misc/NEWS.d/next/Library/2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst b/Misc/NEWS.d/next/Library/2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst
@@ -1 +1 @@
-Add support for ``-nolinestop``, and ``-strictlimits`` options to ``!tkinter.Text.search``. Also add the ``tkinter.Text.search_all`` method for ``-all`` and ``overlap`` options
+Add support for ``-nolinestop``, and ``-strictlimits`` options to :meth:`!tkinter.Text.search`. Also add the :meth:`!tkinter.Text.search_all` method for ``-all`` and ``-overlap`` options.

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-Add support for ``-nolinestop``, and ``-strictlimits`` options to ``!tkinter.Text.search``. Also add the ``tkinter.Text.search_all`` method for ``-all`` and ``overlap`` options
	`1`	+Add support for ``-nolinestop``, and ``-strictlimits`` options to :meth:`!tkinter.Text.search`. Also add the :meth:`!tkinter.Text.search_all` method for ``-all`` and ``-overlap`` options.