Skip to content

Commit 7ea4b02

Browse files
committed
Dict.Behaviour doc cleanup
1 parent 11423af commit 7ea4b02

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

lib/elixir/lib/dict/behaviour.ex

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
defmodule Dict.Behaviour do
22
@moduledoc """
3+
Default implementations for some required functions in the `Dict` module.
4+
35
This module makes it easier to create your own `Dict` compliant
46
module, by providing default implementations for some required functions.
57
@@ -13,16 +15,16 @@ defmodule Dict.Behaviour do
1315
# override default implementations if needed
1416
end
1517
16-
The client module must contain following functions:
18+
The client module must contain the following functions:
1719
1820
* `delete/2`
19-
* `fetch/2`,
21+
* `fetch/2`
2022
* `put/3`
2123
* `reduce/3`
2224
* `size/1`
2325
* `update/4`
2426
25-
All of them are part of the Dict behaviour, so no extra functions are
27+
All of which are part of the `Dict` behaviour, so no extra functions are
2628
actually required.
2729
2830
Based on these functions, `Dict.Behaviour` generates default implementations
@@ -42,7 +44,7 @@ defmodule Dict.Behaviour do
4244
* `to_list/1`
4345
* `values/1`
4446
45-
All of the functions are defined as overridable, so you can provide your own
47+
All of these functions are defined as overridable, so you can provide your own
4648
implementation if needed.
4749
4850
Note you can also test your custom module via `Dict`'s doctests:

0 commit comments

Comments
 (0)