Update README and hide modules in documentation

addvalue-gmbh · May 19, 2016 · 2312fc2 · 2312fc2
1 parent 769cbf8
commit 2312fc2
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ end
 def index(conn, params) do
   page = MyApp.Person
   |> where([p], p.age > 30)
-  |> order_by([p], desc: p.age)
+  |> order_by(desc: :age)
   |> preload(:friends)
   |> MyApp.Repo.paginate(params)
 
@@ -50,7 +50,7 @@ end
 ```elixir
 page = MyApp.Person
 |> where([p], p.age > 30)
-|> order_by([p], desc: p.age)
+|> order_by(desc: :age)
 |> preload(:friends)
 |> MyApp.Repo.paginate(page: 2, page_size: 5)
 ```

diff --git a/lib/scrivener/paginater/atom.ex b/lib/scrivener/paginater/atom.ex
@@ -1,4 +1,6 @@
 defimpl Scrivener.Paginater, for: Atom do
+  @moduledoc false
+
   @spec paginate(atom, Scrivener.Config.t) :: Scrivener.Page.t
   def paginate(atom, config) do
     atom

diff --git a/lib/scrivener/paginater/ecto/query.ex b/lib/scrivener/paginater/ecto/query.ex
@@ -3,6 +3,8 @@ defimpl Scrivener.Paginater, for: Ecto.Query do
 
   alias Scrivener.{Config, Page}
 
+  @moduledoc false
+
   @spec paginate(Ecto.Query.t, Scrivener.Config.t) :: Scrivener.Page.t
   def paginate(query, %Config{page_size: page_size, page_number: page_number, module: repo}) do
     total_entries = total_entries(query, repo)