Merge branch 'master' of https://github.com/GenieFramework/SearchLigh…

…t.jl
GenieFramework · Aug 7, 2022 · f6cbfa7 · f6cbfa7 · essenciary · Aug 7, 2022
2 parents 21dd98d + 400e17f
commit f6cbfa7
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/src/Relationships.jl b/src/Relationships.jl
@@ -43,7 +43,32 @@ function Relationship(r1::Type{T}, r2::Type{R}; context::Module = @__MODULE__)::
   getfield(context, Symbol(relationship_name(r1, r2)))
 end
 
+"""
+      Relationship!(r1::T, r2::R; context::Module)::AbstractModel where {T<:AbstractModel, R<:AbstractModel}
 
+Relationship takes two AbstractModel types and 
+      
+# Examples
+```julia
+julia> Base.@kwdef mutable struct Role <: AbstractModel
+         id::DbId = DbId()
+         name::String = ""
+       end
+julia> Role(name::Union{String,Symbol}) = Role(name = string(name))
+
+
+julia> Base.@kwdef mutable struct Permission <: AbstractModel
+         id::DbId = DbId()
+         name::String = ""
+       end
+julia> Permission(name::Union{String,Symbol}) = Permission(name = string(name))
+
+
+julia> Relationship!(user, role)
+
+julia> isrelated(role, permission)
+```
+"""
 function Relationship!(r1::T, r2::R; context::Module = @__MODULE__)::AbstractModel where {T<:AbstractModel, R<:AbstractModel}
   relationship = Relationship(typeof(r1), typeof(r2); context = context)