]> granicus.if.org Git - python/commitdiff
Add a note to the str.find doc to suggest the use of the "in" operator.
authorEzio Melotti <ezio.melotti@gmail.com>
Mon, 9 May 2011 00:54:30 +0000 (03:54 +0300)
committerEzio Melotti <ezio.melotti@gmail.com>
Mon, 9 May 2011 00:54:30 +0000 (03:54 +0300)
Doc/library/stdtypes.rst

index 7621eef4ae9605915af314b32d1fa703e62d3a56..2e3e18feac69aa6447fbb7cd1aa978b9cb595e16 100644 (file)
@@ -883,6 +883,15 @@ 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)