diff --git a/docs/src/index.md b/docs/src/index.md index fa75053..a70ce03 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -123,6 +123,7 @@ NoJudgement rating certainty ``` + ## Metadata ```@docs diff --git a/src/record.jl b/src/record.jl index 6af2890..2ceafe5 100644 --- a/src/record.jl +++ b/src/record.jl @@ -1,8 +1,3 @@ -""" - Record() - -Build a new Record, e.g. a Paper. -""" struct Record <: JudgementLevel rater::Union{AbstractString, Missing} id::Union{Base.UUID, Missing} @@ -15,6 +10,11 @@ function Record(rater, id::String, location, meta, judgements) Record(rater, Base.UUID(id), location, meta, judgements) end +""" + Record(j...; rater = missing, id = missing, location = missing, meta = missing) + +Record represents every paper(like) thing that is coded. It contains who is rating it, what is being rated (uniquely identified by an `id`), where to find it (`location`) and other metadata (usually automatically infered). +""" function Record(j...; rater = missing, id = missing, location = missing, meta = missing) if ismissing(rater) @warn "Please provide your rater ID. This should be your initials."