Skip to content

Commit

Permalink
Correct documentation (#25)
Browse files Browse the repository at this point in the history
The code example for custom implementations was incorrect and I added a
header.
  • Loading branch information
andersonmcook authored Sep 23, 2024
1 parent 6c9662a commit 88e83d0
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,12 +118,14 @@ And attach:
)
```

## Custom `Jason.Encoder` Implementations

Structs that implement [Jason.Encoder](https://hexdocs.pm/jason/Jason.Encoder.html) will use that protocol.
If any implementation is undesirable, as is the case with `Ecto.Association.NotLoaded`
and `Ecto.Schema.Metadata` which both raise errors as of `3.12.3`, it can be disabled at runtime.

```elixir
config, :medea, except: [Ecto.Association.NotLoaded, Ecto.Schema.Metadata]
config :medea, except: [Ecto.Association.NotLoaded, Ecto.Schema.Metadata]
```

Additional documentation can be found at [https://hexdocs.pm/medea](https://hexdocs.pm/medea).
Expand Down

0 comments on commit 88e83d0

Please sign in to comment.