Skip to content

Update console dialog helper documentation #7572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 21, 2017

Conversation

atailouloute
Copy link
Contributor

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

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 it's validated using the ``$validator`` callback.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm this change is legit, but not enough explicit, what about:

and it's validated using the ``$validator`` callback, printing the error
on remaining attempts. If the last attempt is reached an exception is
thrown and displayed to the user, ending the process.

?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've reworded as suggested. This is now ready to be merged. Thanks!

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 it's validated using the ``$validator`` callback.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've reworded as suggested. This is now ready to be merged. Thanks!

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, "the remaining number of attempts is displayed" sounds wrong, only an error message is displayed.

@xabbuh xabbuh added this to the 2.7 milestone Jul 9, 2017
@xabbuh
Copy link
Member

xabbuh commented Jul 21, 2017

Thank you @atailouloute.

@xabbuh xabbuh merged commit 400f410 into symfony:2.7 Jul 21, 2017
xabbuh added a commit that referenced this pull request Jul 21, 2017
…OUTE, javiereguiluz)

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
xabbuh added a commit that referenced this pull request Jul 21, 2017
xabbuh added a commit that referenced this pull request Jul 21, 2017
* 2.7:
  Reworded the article about form login redirects
  Explained the edge-case where the use_referer option doesn't work
  [#7572] fix wording
  [#7585] remove trailing whitespaces
  [#7585] minor rewording
  Fixed a typo
  Fixed a typo
  Update parent_services for tip consistency
  [#7685] use the method role
  Minor change
  Updating doc to specify priority of default normalizer
  [#7767] remove trailing space
  Minor reword
  Moved array validation to the Raw values sub-guide
  Fixed some syntax issues
  missing constraint example from the old readme
  Update console dialog helper documentation
  Improved the advantages/drawbacks of "controllers as services"
xabbuh added a commit that referenced this pull request Jul 21, 2017
* 2.8: (37 commits)
  [#8192] use path() in PHP templates
  Reworded the article about form login redirects
  Explained the edge-case where the use_referer option doesn't work
  [#7572] fix wording
  [#7585] remove trailing whitespaces
  [#7585] minor rewording
  Fixed a typo
  Fixed a typo
  Update parent_services for tip consistency
  [#7685] use the method role
  Minor change
  Updating doc to specify priority of default normalizer
  [#7767] remove trailing space
  [#7767] replace "options" with "entry_options"
  [#7767] minor rewording
  [#8047] add inline code comment
  Fixed the issue in a different way
  Jquery datePicker syntax update
  [#8104] minor rewording
  Add more precision about automatic provider assignation
  ...
xabbuh added a commit that referenced this pull request Jul 21, 2017
* 3.2: (38 commits)
  [#8192] use path() in PHP templates
  Reworded the article about form login redirects
  Explained the edge-case where the use_referer option doesn't work
  [#7572] fix wording
  [#7585] remove trailing whitespaces
  [#7585] minor rewording
  Fixed a typo
  Fixed a typo
  Update parent_services for tip consistency
  [#7685] use the method role
  Minor change
  Updating doc to specify priority of default normalizer
  [#7767] remove trailing space
  [#7767] replace "options" with "entry_options"
  [#7767] minor rewording
  [#8047] add inline code comment
  Fixed the issue in a different way
  Jquery datePicker syntax update
  Fix framework instantiation in event-dispatcher
  [#8104] minor rewording
  ...
xabbuh added a commit that referenced this pull request Jul 21, 2017
* 3.3: (46 commits)
  [#8192] use path() in PHP templates
  Reworded the article about form login redirects
  Update Flex documentation with latest structure
  Explained the edge-case where the use_referer option doesn't work
  [#7572] fix wording
  [#7585] remove trailing whitespaces
  [#7585] minor rewording
  Fixed a typo
  Fixed a typo
  Update parent_services for tip consistency
  [#7685] use the method role
  Minor change
  Updating doc to specify priority of default normalizer
  [#7767] remove trailing space
  [#7767] replace "options" with "entry_options"
  [#7767] minor rewording
  [#8047] add inline code comment
  Fixed the issue in a different way
  Jquery datePicker syntax update
  Fix framework instantiation in event-dispatcher
  ...
xabbuh added a commit that referenced this pull request Jul 21, 2017
* 3.4: (48 commits)
  [#8192] use path() in PHP templates
  Reworded the article about form login redirects
  Update Flex documentation with latest structure
  Explained the edge-case where the use_referer option doesn't work
  [#7572] fix wording
  [#7585] remove trailing whitespaces
  [#7585] minor rewording
  Fixed a typo
  Fixed a typo
  Update parent_services for tip consistency
  [#7685] use the method role
  Minor change
  Updating doc to specify priority of default normalizer
  [#7767] remove trailing space
  [#7767] replace "options" with "entry_options"
  [#7767] minor rewording
  [#8047] add inline code comment
  Fixed the issue in a different way
  Jquery datePicker syntax update
  Fix framework instantiation in event-dispatcher
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants