Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix deliver_later typo in doc #598

Merged
merged 1 commit into from
Apr 22, 2021
Merged

fix deliver_later typo in doc #598

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/bamboo/mailer.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ defmodule Bamboo.Mailer do
@doc """
Deliver an email in the background.

Same as `deliver_later!/2` but does not return an ok tuple and raises on
Same as `deliver_later/2` but does not return an ok tuple and raises on
Copy link
Collaborator

Choose a reason for hiding this comment

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

I believe this is actually correct as is.

These docs are for the deliver_later!/2 function, but here they're saying that the function is the same as deliver_later/2 (the non-bang version) except deliver_later!/2 raises on errors.

Does that make sense? Do you think we could make that more clear?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@germsvel That's what I was trying to do, remove the !, so it reads Same as deliver_later/2 now.

Copy link
Collaborator

Choose a reason for hiding this comment

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

🤦 I read that backwards, huh? 😅

Thanks for catching that. Looks good!

errors.

If successful, this function only returns the `Email` struct.
Expand Down