From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 6 Jan 2026 21:48:19 +0000 (+0100)
Subject: [3.14] gh-106318: Add example for str.index()  (GH-137023) (#143502)
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=951bb2ab4b5f63ff77a1f6b00b5f6527bc2ce0b0;p=thirdparty%2FPython%2Fcpython.git

[3.14] gh-106318: Add example for str.index()  (GH-137023) (#143502)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
---

diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 1e9efbb97cff..492282dc7b7c 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -2045,7 +2045,18 @@ expression support in the :mod:`re` module).
 .. method:: str.index(sub[, start[, end]])
 
    Like :meth:`~str.find`, but raise :exc:`ValueError` when the substring is
-   not found.
+   not found. For example:
+
+   .. doctest::
+
+      >>> 'spam, spam, spam'.index('eggs')
+      Traceback (most recent call last):
+        File "<python-input-0>", line 1, in <module>
+          'spam, spam, spam'.index('eggs')
+          ~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^
+      ValueError: substring not found
+
+   See also :meth:`rindex`.
 
 
 .. method:: str.isalnum()