Reworded the explanation about flash messages #5808
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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.
missing second backtick after "error"
| 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 |
|
@javiereguiluz I suggest you to also update the Twig code snippet to follow the Twig coding standards (snake_case variable names, so |
weaverryan
added a commit
that referenced
this pull request
Nov 5, 2015
…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
weaverryan
added a commit
that referenced
this pull request
Nov 5, 2015
…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 :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
.. noteadmonition at the end of the section.