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.

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

Fix type spec & doc of Formatter.format_email_address/2 #585

Merged
merged 1 commit into from
Feb 23, 2021
Merged
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions lib/bamboo/formatter.ex
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ defprotocol Bamboo.Formatter do
"""

@doc ~S"""
Receives data and opts and returns a string or a two item tuple `{name, address}`
Receives data and opts and returns a string, a two item tuple `{name, address}`, or a list of either.

opts is a map with the key `:type` and a value of
`:from`, `:to`, `:cc` or `:bcc`. You can pattern match on this to customize
Expand All @@ -65,7 +65,7 @@ defprotocol Bamboo.Formatter do

@type opts :: %{optional(:type) => :from | :to | :cc | :bcc}

@spec format_email_address(any, opts) :: Bamboo.Email.address()
@spec format_email_address(any, opts) :: Bamboo.Email.address_list()
Copy link
Collaborator

Choose a reason for hiding this comment

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

👍

def format_email_address(data, opts)
end

Expand Down