diff --git a/lib/ash/api/interface.ex b/lib/ash/api/interface.ex index a6815d87..68df740b 100644 --- a/lib/ash/api/interface.ex +++ b/lib/ash/api/interface.ex @@ -1,7 +1,5 @@ defmodule Ash.Api.Interface do - @moduledoc """ - The primary entry point for interacting with resources and their data. - """ + @moduledoc false import Ash.OptionsHelpers, only: [merge_schemas: 3] diff --git a/lib/ash/error.ex b/lib/ash/error.ex index 87d37e65..fc29d6cf 100644 --- a/lib/ash/error.ex +++ b/lib/ash/error.ex @@ -96,6 +96,8 @@ defmodule Ash.Error do end defprotocol Ash.ErrorKind do + @moduledoc false + @spec id(t()) :: String.t() def id(error) diff --git a/lib/ash/filter/filter.ex b/lib/ash/filter/filter.ex index eebf2850..9117c1ba 100644 --- a/lib/ash/filter/filter.ex +++ b/lib/ash/filter/filter.ex @@ -1,22 +1,22 @@ defmodule Ash.Filter do - @moduledoc """ - A filter expression in Ash. + @moduledoc false - The way we represent filters may be strange, but its important to have it structured, - as merging and checking filter subsets are used all through ash for things like - authorization. The `ands` of a filter are not subject to its `ors`. The `not` of a filter - is also *not* subject to its `ors`. - For instance, if a filter `A` has two `ands`, `B` and `C` and two `ors`, `D` and `E`, and - a `not` of F, the expression as can be represented as `(A or D or E) and NOT F and B and C`. + # A filter expression in Ash. - The filters `attributes` and `relationships`, *are* subject to the `ors` of that filter. + # The way we represent filters may be strange, but its important to have it structured, + # as merging and checking filter subsets are used all through ash for things like + # authorization. The `ands` of a filter are not subject to its `ors`. The `not` of a filter + # is also *not* subject to its `ors`. + # For instance, if a filter `A` has two `ands`, `B` and `C` and two `ors`, `D` and `E`, and + # a `not` of F, the expression as can be represented as `(A or D or E) and NOT F and B and C`. - ` AND NOT AND ( OR )` + # The filters `attributes` and `relationships`, *are* subject to the `ors` of that filter. - This probably needs to be refactored into something more representative of its behavior, - like a series of nested boolean expression structs w/ a reference to the attribute/relationship - it references. Maybe. This would be similar to Ecto's `BooleanExpr` structs. - """ + # ` AND NOT AND ( OR )` + + # This probably needs to be refactored into something more representative of its behavior, + # like a series of nested boolean expression structs w/ a reference to the attribute/relationship + # it references. Maybe. This would be similar to Ecto's `BooleanExpr` structs. alias Ash.Actions.PrimaryKeyHelpers alias Ash.Engine diff --git a/lib/ash/resource/actions/create.ex b/lib/ash/resource/actions/create.ex index a7874624..3fdb0bfd 100644 --- a/lib/ash/resource/actions/create.ex +++ b/lib/ash/resource/actions/create.ex @@ -1,5 +1,5 @@ defmodule Ash.Resource.Actions.Create do - @moduledoc "The representation of a `create` action." + @moduledoc false defstruct [:type, :name, :primary?] @type t :: %__MODULE__{ diff --git a/lib/ash/resource/actions/destroy.ex b/lib/ash/resource/actions/destroy.ex index b437fd40..727f7404 100644 --- a/lib/ash/resource/actions/destroy.ex +++ b/lib/ash/resource/actions/destroy.ex @@ -1,5 +1,5 @@ defmodule Ash.Resource.Actions.Destroy do - @moduledoc "The representation of a `destroy` action" + @moduledoc false defstruct [:type, :name, :primary?] diff --git a/lib/ash/resource/actions/update.ex b/lib/ash/resource/actions/update.ex index a1d1a2dd..472f771e 100644 --- a/lib/ash/resource/actions/update.ex +++ b/lib/ash/resource/actions/update.ex @@ -1,5 +1,5 @@ defmodule Ash.Resource.Actions.Update do - @moduledoc "The representation of a `update` action" + @moduledoc false defstruct [:type, :name, :primary?] diff --git a/lib/ash/resource/relationships/belongs_to.ex b/lib/ash/resource/relationships/belongs_to.ex index a0817c55..4017d693 100644 --- a/lib/ash/resource/relationships/belongs_to.ex +++ b/lib/ash/resource/relationships/belongs_to.ex @@ -1,5 +1,5 @@ defmodule Ash.Resource.Relationships.BelongsTo do - @moduledoc "The representation of a `belongs_to` relationship" + @moduledoc false defstruct [ :name, :cardinality, diff --git a/lib/ash/resource/schema.ex b/lib/ash/resource/schema.ex index d53ca628..5cda223e 100644 --- a/lib/ash/resource/schema.ex +++ b/lib/ash/resource/schema.ex @@ -1,10 +1,10 @@ defmodule Ash.Schema do - @moduledoc """ - Defines an ecto schema for a resource. + @moduledoc false - This defines struct representation of a resource. Data layers can rely on this - schema for persistence. - """ + # Defines an ecto schema for a resource. + + # This defines struct representation of a resource. Data layers can rely on this + # schema for persistence. defmacro define_schema(name) do quote do