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

Mismatch of File doc and Hexdoc #16

Closed
philippneugebauer opened this issue Feb 23, 2018 · 1 comment
Closed

Mismatch of File doc and Hexdoc #16

philippneugebauer opened this issue Feb 23, 2018 · 1 comment

Comments

@philippneugebauer
Copy link

There is a slight difference of the documentation between https://github.com/swoosh/phoenix_swoosh/blob/master/lib/phoenix_swoosh.ex and https://hexdocs.pm/phoenix_swoosh/Phoenix.Swoosh.html in the Sample.UserEmail module.
For the hexdoc, an added alias Swoosh.Email is required to compile the snippet succesfully, but which doc is the preferred one?

@stevedomin
Copy link
Member

Hi @philippneugebauer,

Sorry about this, the code was updated but we didn't push the docs.

I'd recommend going with the new/0 function, it is the preferred way to initialise a new Email struct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants