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

Module doc error when deriving protocols on modules you don't own #58

Open
tristantreb opened this issue Dec 8, 2022 · 0 comments
Open

Comments

@tristantreb
Copy link

Context: I implemented protocols to encode to JSON as advised here,
"""
If you don't own the struct you want to encode to JSON, you may use Protocol.derive/3 placed outside of any module:

Protocol.derive(Jason.Encoder, NameOfTheStruct, only: [...])
Protocol.derive(Jason.Encoder, NameOfTheStruct)

"""

Issue: mix doctor complains that there's no module doc when I derive a Protocol from a module I don't own.

Is it a bug?
The best workaround I found is to ignore the related modules from .doctor.exs

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

1 participant