Update README.md #552
Update README.md #552
Conversation
There was a problem hiding this comment.
Thanks for opening these changes @Raulkumar. There are a few places where the original language was correct. Do you think you could revert those changes?
| - **Deliver emails in the background**. Most of the time you don't want or need | ||
| to wait for the email to send. Bamboo makes it easy with | ||
| Mailgun, and SendGrid][available-adapters]. It's also quite easy to write your delivery adapter if your platform isn't yet supported. | ||
| - **Deliver emails in the background**. Most of the time you don't want or need to wait for the email to send. Bamboo makes it easy with |
There was a problem hiding this comment.
I don't think the text change here, correct? Could we leave this as it was? I think we prefer the text wrapping for legibility.
| `Mailer.deliver_later`. | ||
| - **A functional approach to mail delivery**. Emails are created, manipulated, | ||
| and sent using plain functions. This makes composition a breeze and fits | ||
| naturally into your existing Elixir app. | ||
| and sent using plain functions. This makes composition a breeze and fits naturally into your existing Elixir app. |
There was a problem hiding this comment.
Could we undo this change? I think we prefer the text wrapping.
| - **Unit test with ease**. Bamboo separates email creation and email delivery | ||
| allowing you to test by asserting against email fields without the need for | ||
| special functions. | ||
| - **Dead-simple integration tests**. Bamboo provides helper functions to make | ||
| - **dead-simple integration tests**. Bamboo provides helper functions to make |
There was a problem hiding this comment.
I think this made more sense as it was, but I'm happy to change this if it makes more sense. Why did you think we should lower case the d?
| @@ -150,7 +147,7 @@ defmodule MyApp.SomeControllerPerhaps do | |||
| end | |||
| ``` | |||
|
|
|||
| Your application is now set up to send email with Bamboo! :tada: | |||
| Your application is now set up to send an email with Bamboo! :tada: | |||
There was a problem hiding this comment.
I think this used to be correct before. The whole application was set up to send email (not just an email) with Bamboo. Does that make sense?
| @@ -190,29 +187,29 @@ config :my_app, MyApp.Mailer, | |||
| ``` | |||
|
|
|||
| You can create new adapters for any environment by implementing the | |||
| [`Bamboo.Adapter`] behaviour. | |||
| [`Bamboo.Adapter`] behavior. | |||
There was a problem hiding this comment.
The previous spelling was the correct one. Behaviours (with the u) are part for Elixir and Erlang. So we want to keep the other spelling to communicate that we mean an Elixir/Erlang behaviour.
| process completion (e.g. a web request in Phoenix). Bamboo provides a | ||
| `deliver_later` function on your mailers to send emails in the background. It | ||
| also provides a [`Bamboo.DeliverLaterStrategy`] behaviour that you can | ||
| also provides a [`Bamboo.DeliverLaterStrategy`] behavior that you can |
There was a problem hiding this comment.
The previous spelling was the correct one. Behaviours (with the u) are part for Elixir and Erlang. So we want to keep the other spelling to communicate that we mean an Elixir/Erlang behaviour.
| linking to the calling process, so errors in the mailer won't bring down your | ||
| app. | ||
|
|
||
| You can also create custom strategies by implementing the | ||
| [`Bamboo.DeliverLaterStrategy`] behaviour. For example, you could create | ||
| [`Bamboo.DeliverLaterStrategy`] behavior. For example, you could create |
There was a problem hiding this comment.
The previous spelling was the correct one. Behaviours (with the u) are part for Elixir and Erlang. So we want to keep the other spelling to communicate that we mean an Elixir/Erlang behaviour.
Supersedes: #552 What changed? ============== Raulkumar was kind enough to make a few changes to the README, including adding commas where needed, capitalizing OTP, among other things in #552. Not all the changes were desired, so this commit includes the correct changes while leaving the other ones out. Co-authored-by: @Raulkumar
|
Closed by 5e35f5f |
No description provided.