From 21721ca240a79032e63b02f1a2b5ca9c5de0386a Mon Sep 17 00:00:00 2001 From: Matthew Johnston Date: Wed, 7 Dec 2022 08:13:20 -0600 Subject: [PATCH] fix documentation --- lib/exqlite/connection.ex | 2 +- lib/exqlite/error.ex | 7 +++++-- lib/exqlite/result.ex | 4 +++- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/lib/exqlite/connection.ex b/lib/exqlite/connection.ex index 09f1a3c3..5dc6d9dc 100644 --- a/lib/exqlite/connection.ex +++ b/lib/exqlite/connection.ex @@ -278,7 +278,7 @@ defmodule Exqlite.Connection do end @doc """ - Close a query prepared by `c:handle_prepare/3` with the database. Return + Close a query prepared by `handle_prepare/3` with the database. Return `{:ok, result, state}` on success and to continue, `{:error, exception, state}` to return an error and continue, or `{:disconnect, exception, state}` to return an error and disconnect. diff --git a/lib/exqlite/error.ex b/lib/exqlite/error.ex index 9cdb6caa..d445e354 100644 --- a/lib/exqlite/error.ex +++ b/lib/exqlite/error.ex @@ -1,8 +1,11 @@ defmodule Exqlite.Error do - @moduledoc false + @moduledoc """ + The error emitted from SQLite or a general error with the library. + """ + defexception [:message, :statement] - @type t() :: %__MODULE__{ + @type t :: %__MODULE__{ message: String.t(), statement: String.t() } diff --git a/lib/exqlite/result.ex b/lib/exqlite/result.ex index 4d3a3f02..53f59391 100644 --- a/lib/exqlite/result.ex +++ b/lib/exqlite/result.ex @@ -1,5 +1,7 @@ defmodule Exqlite.Result do - @moduledoc false + @moduledoc """ + The database results. + """ @type t :: %__MODULE__{ command: atom,