mirror of
https://github.com/ash-project/ash.git
synced 2024-09-19 13:03:02 +12:00
docs: make most moduledocs private
This commit is contained in:
parent
84422d1f98
commit
6b73e855a1
8 changed files with 26 additions and 26 deletions
|
@ -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]
|
||||
|
||||
|
|
|
@ -96,6 +96,8 @@ defmodule Ash.Error do
|
|||
end
|
||||
|
||||
defprotocol Ash.ErrorKind do
|
||||
@moduledoc false
|
||||
|
||||
@spec id(t()) :: String.t()
|
||||
def id(error)
|
||||
|
||||
|
|
|
@ -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_statements> AND NOT <not_statement> AND (<one_of_or_statements> OR <attributes + relationships>)`
|
||||
# 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_statements> AND NOT <not_statement> AND (<one_of_or_statements> OR <attributes + relationships>)`
|
||||
|
||||
# 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
|
||||
|
|
|
@ -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__{
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
defmodule Ash.Resource.Actions.Destroy do
|
||||
@moduledoc "The representation of a `destroy` action"
|
||||
@moduledoc false
|
||||
|
||||
defstruct [:type, :name, :primary?]
|
||||
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
defmodule Ash.Resource.Actions.Update do
|
||||
@moduledoc "The representation of a `update` action"
|
||||
@moduledoc false
|
||||
|
||||
defstruct [:type, :name, :primary?]
|
||||
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
defmodule Ash.Resource.Relationships.BelongsTo do
|
||||
@moduledoc "The representation of a `belongs_to` relationship"
|
||||
@moduledoc false
|
||||
defstruct [
|
||||
:name,
|
||||
:cardinality,
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue