]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
#6211: elaborate a bit on ways to call the function.
authorGeorg Brandl <georg@python.org>
Sat, 6 Jun 2009 17:50:05 +0000 (17:50 +0000)
committerGeorg Brandl <georg@python.org>
Sat, 6 Jun 2009 17:50:05 +0000 (17:50 +0000)
Doc/tutorial/controlflow.rst

index cc1d334a7a89e49b18fd062c6fc30a43288699cd..3c6d16468db1d5767d11c939156f7f59a79292eb 100644 (file)
@@ -312,14 +312,23 @@ defined to allow.  For example::
    def ask_ok(prompt, retries=4, complaint='Yes or no, please!'):
        while True:
            ok = raw_input(prompt)
-           if ok in ('y', 'ye', 'yes'): return True
-           if ok in ('n', 'no', 'nop', 'nope'): return False
+           if ok in ('y', 'ye', 'yes'):
+               return True
+           if ok in ('n', 'no', 'nop', 'nope'):
+               return False
            retries = retries - 1
-           if retries < 0: raise IOError('refusenik user')
+           if retries < 0:
+               raise IOError('refusenik user')
            print complaint
 
-This function can be called either like this: ``ask_ok('Do you really want to
-quit?')`` or like this: ``ask_ok('OK to overwrite the file?', 2)``.
+This function can be called in several ways:
+
+* giving only the mandatory argument:
+  ``ask_ok('Do you really want to quit?')``
+* giving one of the optional arguments:
+  ``ask_ok('OK to overwrite the file?', 2)``
+* or even giving all arguments:
+  ``ask_ok('OK to overwrite the file?', 2, 'Come on, only yes or no!')``
 
 This example also introduces the :keyword:`in` keyword. This tests whether or
 not a sequence contains a certain value.