summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEzio Melotti <ezio.melotti@gmail.com>2011-05-09 03:54:30 +0300
committerEzio Melotti <ezio.melotti@gmail.com>2011-05-09 03:54:30 +0300
commit760c8b1cff5ebeb37d265dd39319f0b560043302 (patch)
tree4e619237e06728f6637218ff1903e1113f88d2b7
parent4f2efab870ac997d6b1f2ae9f13278b25330a024 (diff)
downloadcpython-760c8b1cff5ebeb37d265dd39319f0b560043302.tar.gz
Add a note to the str.find doc to suggest the use of the "in" operator.
-rw-r--r--Doc/library/stdtypes.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 64496326f7..0e32348b9b 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -944,6 +944,15 @@ string functions based on regular expressions.
*start* and *end* are interpreted as in slice notation. Return ``-1`` if
*sub* is not found.
+ .. note::
+
+ The :meth:`~str.find` method should be used only if you need to know the
+ position of *sub*. To check if *sub* is a substring or not, use the
+ :keyword:`in` operator::
+
+ >>> 'Py' in 'Python'
+ True
+
.. method:: str.format(*args, **kwargs)