fix deliver_later typo in doc #598
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
germsvel
reviewed
Apr 20, 2021
| @@ -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 | |||
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
@germsvel That's what I was trying to do, remove the !, so it reads Same as deliver_later/2 now.
There was a problem hiding this comment.
🤦 I read that backwards, huh? 😅
Thanks for catching that. Looks good!
|
STEEEEEEVE |
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.
This looks like it's supposed to refer to the non
!version of this function.