Merge pull request #142 from formal-methods-mpi/documentation/record

add doc string for record
formal-methods-mpi · Feb 12, 2024 · 35eaa3c · 35eaa3c
2 parents a0066f7 + 5951944
commit 35eaa3c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git 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
@@ -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."
-Original file line number
+Diff line change
@@ Expand Up / @@ -123,6 +123,7 @@ NoJudgement @@
     rating
     certainty
     ```
     ## Metadata
     ```@docs
@@ Expand Down @@