Skip to content

Commit

Permalink
Clean up documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dmarkow committed May 13, 2017
1 parent 205815d commit d559561
Showing 1 changed file with 0 additions and 19 deletions.
19 changes: 0 additions & 19 deletions lib/ecto_ranked.ex
Original file line number Diff line number Diff line change
@@ -1,25 +1,6 @@
defmodule EctoRanked do
@moduledoc """
EctoRanked uses a rank column to provides changeset methods for updating ordering an ordering column
Sample usage:
```
defmodule MyApp.Item do
use MyApp.Web, :model
schema "items" do
field :rank, :integer
field :position, :any, virtual: true
belongs_to :parent, MyApp.Parent
end
def changeset(struct, params \\ %{}) do
struct
|> cast(params, [:position])
|> set_rank(:parent_id)
end
end
```
"""
import Ecto.Changeset
import Ecto.Query
Expand Down

0 comments on commit d559561

Please sign in to comment.