minor #7572 Update console dialog helper documentation (Ahmed TAILOULOUTE, javiereguiluz)

xabbuh · xabbuh · commit 3693865f8fa3 · 2017-07-21T12:35:30.000+02:00
This PR was merged into the 2.7 branch. Discussion ---------- Update console dialog helper documentation `If you reach this max number it will use the default value.` is not always true, on the last attempt we can supply an answer and the default one is not used Actually the default answer is used each time the user is asked the question if the user didn't specify any answer and it's validated using the `validator` callback Commits ------- 400f410 Minor reword fbf40a7 Update console dialog helper documentation
diff --git a/components/console/helpers/dialoghelper.rst b/components/console/helpers/dialoghelper.rst
@@ -142,11 +142,15 @@ in the console, so it is a good practice to put some useful information in it. T
 function should also return the value of the user's input if the validation was successful.
 
 You can set the max number of times to ask in the ``$attempts`` argument.
-If you reach this max number it will use the default value.
 Using ``false`` means the amount of attempts is infinite.
 The user will be asked as long as they provide an invalid answer and will only
 be able to proceed if their input is valid.
 
+Each time the user is asked the question, if no answer is supplied, the default
+one is used (and validated with the ``$validator`` callback) and the remaining
+number of attempts is displayed. If the last attempt is reached, the application
+throws an exception and ends its execution.
+
 Validating a Hidden Response
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
