Merge pull request #148 from formal-methods-mpi/fix_docstrings

minor changes to index
formal-methods-mpi · Feb 13, 2024 · 1fa9c87 · 1fa9c87
2 parents 6167fad + 1b61cad
commit 1fa9c87
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 24 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -39,7 +39,7 @@ Besides enabling better simulations, knowing how common different types of SEMs
 
 ## Data Base
 ```@docs
-RecordDatabase(records::Record...)
+RecordDatabase
 ```
 
 ## Taxons

diff --git a/src/database.jl b/src/database.jl
@@ -12,31 +12,10 @@ end
 
 
 """
-    RecordDatabase()
+RecordDatabase
 
 `Record`s need to be stored somewhere.
-
-```jldoctest
-julias> RecordDatabase()
-RecordDatabase{Base.UUID, Record}()
-
-julia> first = Record(rater = "AP", id = "552ef675-5c7b-4ce1-880b-c45b833fdfcb", location = NoLocation(), meta = MetaData(missing, missing, missing), judgements = Dict("Taxon" => J(NoTaxon())), spec = NoJudgement(), data = NoJudgement());
-
-julias> second = Record(rater = "AP", id = "58c55701-0362-40c7-849c-5d12e5026238", location = NoLocation(), meta = MetaData(missing, missing, missing), judgements = Dict("Taxon" => J(NoTaxon())), spec = NoJudgement(), data = NoJudgement());
-
-julia> rd = RecordDatabase(first, second)
-RecordDatabase{Base.UUID, Record} with 2 entries:
-  UUID("58c55701-0362-40c7-849c-5d12e5026238") => Record…
-  UUID("552ef675-5c7b-4ce1-880b-c45b833fdfcb") => Record…
-
-julias> rd += Record(rater = "AP", id = "2d7ad584-8ec0-47dd-807b-280fba2978f8", location = NoLocation(), meta = MetaData(missing, missing, missing), judgements = Dict("Taxon" => J(NoTaxon())), spec = NoJudgement(), data = NoJudgement())
-RecordDatabase{Base.UUID, Record} with 3 entries:
-  UUID("2d7ad584-8ec0-47dd-807b-280fba2978f8") => Record…
-  UUID("58c55701-0362-40c7-849c-5d12e5026238") => Record…
-  UUID("552ef675-5c7b-4ce1-880b-c45b833fdfcb") => Record…
-```
 """
-
 struct RecordDatabase{K<:UUID,V<:Record} <: Base.AbstractDict{K,V}
     records::Dict{K,V}
 end

diff --git a/src/taxons/no_taxon.jl b/src/taxons/no_taxon.jl
@@ -26,7 +26,6 @@ NoTaxonYet gives you the option to name the 'modeltype', you were not able to co
 julia> NoTaxonYet()
 
 """
-
 struct NoTaxonYet <: Taxon
     accessdate::Date
     modeltype::Union{String, Missing}