[Reference] Add missing option delivery_whitelist #4925
Conversation
e-weimann
commented
Jan 26, 2015
e-weimann
commented
| Q | A |
|---|---|
| Doc fix? | yes |
| New docs? | no |
| Applies to | SwiftMailerBundle 2.1 |
| Fixed tickets | no |
|
|
||
| **type**: ``array`` | ||
|
|
||
| If set, only email message send to addresses that match with the values in the list. |
There was a problem hiding this comment.
I think this line should be replaced with:
Used in combination with ``delivery_address``. If set, send email as normal to addresses that match with the values in the list. All addresses not matching will be sent to ``delivery_address`` as is the normal behaviour when setting a ``delivery_address``.
|
This nicely complements my PR #4924 |
|
Thanks @TerjeBr. I only guessed what the option is about. |
|
|
||
| **type**: ``array`` | ||
|
|
||
| Used in combination with ``delivery_address``. If set, send email as normal to addresses that match with the values in the list. All addresses not matching will be sent to ``delivery_address`` as is the normal behaviour when setting a ``delivery_address``. |
There was a problem hiding this comment.
you should add a linebreak after the first word that crosses the 72th character. This makes the source easier to read and review.
|
@wouterj are there any other adjustments I have to do? |
|
@e-weimann no, it looks good. I've now labeled it with "Finished". As soon as he has some time, @weaverryan will take a look at this PR and probably merge it. |
|
|
||
| Used in combination with ``delivery_address``. If set, send email as normal to | ||
| addresses that match with the values in the list. All addresses not matching will | ||
| be sent to ``delivery_address`` as is the normal behaviour when setting a |
There was a problem hiding this comment.
behavior (we use American English for the docs) :)
There was a problem hiding this comment.
@xabbuh Oh no! american english 😬 Well, okay... fixed it...
| Used in combination with ``delivery_address``. If set, send email as normal to | ||
| addresses that match with the values in the list. All addresses not matching will | ||
| be sent to ``delivery_address`` as is the normal behavior when setting a | ||
| ``delivery_address``. |
There was a problem hiding this comment.
We should include a link to the now-merged new section about this: http://symfony.com/doc/current/cookbook/email/dev_environment.html#sending-to-a-specified-address-but-with-exceptions
And with this link, we can make the description here ever shorter - perhaps just:
Used in combination with ``deliver_address``. If set, emails matching this pattern will
be delivered like normal, instead of being sent to `delivery_address`. For details, see
LINK...We'll need to add a new anchor link above that section (e.g. .. _cookbook-emails-delivery_whitelist) so we can link to it.
Thanks!
|
@e-weimann Is there a specific reason you closed your pull request? |
|
@xabbuh yes, it does not appear that the pull request will get merged, so i closed it. |
|
@e-weimann , if you had just done the change @weaverryan asked for, I am sure it would have been merged. But that is ok, I have now created #5056 to be instead of this one. |
|
My apologies (and the rest of the doc team) for giving you this feeling, @e-weimann. We are always trying to give contributors a good experience, as the contributors make a documentation great. For instance, you documented a setting in this PR that I didn't even know before this PR. However, we are quite a small team and the doc activity has increased to a very active state (2 years ago, there were about 20 open PRs and 1 new PR in a couple of days, nowadays we get a minimum of around 3 new PRs each day and have a list of 100+ open PRs). Meanwhile, the main doc merger (@weaverryan) has moved to a new house recently. I think you can see why we are behind the facts at the moment. I hope we don't give you or other contributors a bad experience in the future. If you have suggestions to improve the experience, please tell us. For now, @TerjeBr applied the comment and created a new PR (Thanks @TerjeBr!). However, it's a bit sad that we can't give you the attribution for these changes. |
…eBr) This PR was merged into the 2.3 branch. Discussion ---------- [Reference] Add missing option delivery_whitelist Q | A ---|--- Doc fix? | yes New docs? | no Applies to | SwiftMailerBundle 2.1 Fixed tickets | #4925 Commits ------- 03279dc Added double backticks. And also a full stop. 2aab241 added link target/label in the cookbook ce8719d Changed link into ref 07855f6 Removed + from copied diff 0195619 [Reference] Add missing option delivery_whitelist
