Skip to content

Commit 21721ca

Browse files
committed
fix documentation
1 parent a24d029 commit 21721ca

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

lib/exqlite/connection.ex

+1-1
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ defmodule Exqlite.Connection do
278278
end
279279

280280
@doc """
281-
Close a query prepared by `c:handle_prepare/3` with the database. Return
281+
Close a query prepared by `handle_prepare/3` with the database. Return
282282
`{:ok, result, state}` on success and to continue,
283283
`{:error, exception, state}` to return an error and continue, or
284284
`{:disconnect, exception, state}` to return an error and disconnect.

lib/exqlite/error.ex

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
defmodule Exqlite.Error do
2-
@moduledoc false
2+
@moduledoc """
3+
The error emitted from SQLite or a general error with the library.
4+
"""
5+
36
defexception [:message, :statement]
47

5-
@type t() :: %__MODULE__{
8+
@type t :: %__MODULE__{
69
message: String.t(),
710
statement: String.t()
811
}

lib/exqlite/result.ex

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
defmodule Exqlite.Result do
2-
@moduledoc false
2+
@moduledoc """
3+
The database results.
4+
"""
35

46
@type t :: %__MODULE__{
57
command: atom,

0 commit comments

Comments
 (0)