-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Reworded the explanation about flash messages #5808
Conversation
By design, flash messages are meant to be processed exactly once. This means | ||
that they vanish from the session automatically when they are retrieved from | ||
the flash bag by calling the ``get()`` method. | ||
It's common to use ``notice``, ``warning`` and ``error` as the keys of the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing second backtick after "error"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed. Thanks.
By design, flash messages are meant to be processed exactly once. This means | ||
that they vanish from the session automatically when they are retrieved from | ||
the flash bag by calling the ``get()`` method. | ||
It's common to use ``notice``, ``warning`` and ``error`` as the keys of the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what about success
?
@javiereguiluz I suggest you to also update the Twig code snippet to follow the Twig coding standards (snake_case variable names, so |
…luz) This PR was merged into the 2.3 branch. Discussion ---------- Reworded the explanation about flash messages | Q | A | ------------- | --- | Doc fix? | no | New docs? | no | Applies to | all | Fixed tickets | - As any reword, most of its changes are debatable. However, I think that the reword is better than the current explanation in one thing: the feature that makes flash message self-vanish as soon as they are retrieved is essential to understand their behavior. In my opinion is wrong to explain that in a `.. note` admonition at the end of the section. Commits ------- e38b037 Fixed a RST syntax issue 747f10b Reworded the explanation about flash messages
…en I tweak things a little further :)
Thanks Javier! I merged this in with a few suggested tweaks... and of course I re-read your improvements and improved them (subjectively) even further :) |
As any reword, most of its changes are debatable. However, I think that the reword is better than the current explanation in one thing: the feature that makes flash message self-vanish as soon as they are retrieved is essential to understand their behavior. In my opinion is wrong to explain that in a
.. note
admonition at the end of the section.